| Both sides previous revision
Previous revision
Next revision
|
Previous revision
|
ezfit:solutions_guide:xml_format_and_parameters [2009/05/22 10:05]
smayr |
ezfit:solutions_guide:xml_format_and_parameters [2009/12/01 17:35] (current)
ajdavis |
| Sample File Structure: | Sample File Structure: |
| <html> | <html> |
| <table border="1" cellpadding="1" cellspacing="0" width="700"> | <table border="1" cellpadding="1" cellspacing="0" width="700" class="inline"> |
| <tbody><tr> | <tbody><tr> |
| <th>Sample File Structure</th> | <th>Sample File Structure</th> |
| </tbody></table> | </tbody></table> |
| </html> | </html> |
| |
| === Element Descriptions and Attributes === | === Element Descriptions and Attributes === |
| <html> | <html> |
| |
| <table width="100%" border="1" cellpadding="1" cellspacing="0"> | <table width="100%" border="1" cellpadding="1" cellspacing="0" class="inline"> |
| <tr> | <tr> |
| <th width="24%">Element</th> | <th width="24%">Element</th> |
| <td>Code="<em>CircuitCode</em> <em>AdjName</em>"</td> | <td>Code="<em>CircuitCode</em> <em>AdjName</em>"</td> |
| <td>Container for serveral adjustments. <em>CircuitCode</em> must the the | <td>Container for serveral adjustments. <em>CircuitCode</em> must the the |
| same code defined in <CIRCUIT>. <em>AjdName</em> can be any string | same code defined in <CIRCUIT>. <em>AdjName</em> can be any string |
| that best describes the adjustment.</td> | that best describes the adjustment.</td> |
| |
| <td> Row="<em>RowNumber</em>" </td> | <td> Row="<em>RowNumber</em>" </td> |
| <td>Row (order) where to display it. Row numbering starts with 0. Eg: Row="0"</td> | <td>Row (order) where to display it. Row numbering starts with 0. Eg: Row="0"</td> |
| | </tr> |
| | |
| | <tr valign="top"> |
| | <td> </td> |
| | <td> Steps="<em>NumSteps</em>" </td> |
| | <td>The number of time(s) to apply a step before moving to the next one.</td> |
| </tr> | </tr> |
| |
| </td> | </td> |
| </tr> | </tr> |
| | |
| <tr valign="top"> | <tr valign="top"> |
| <td> </td> | <td> </td> |
| |
| Example file ''fittingguide.xml'': | Example file ''fittingguide.xml'': |
| <code> | |
| <CIRCUIT Code="FOUNDATION" Title="FOUNDATION"> | |
| <ISSUE Title="FEEDBACK"> | |
| <ADJUSTMENTS Code="FOUNDATION FEEDBACK (Constant)"> | |
| <ADJUSTMENT Row="0" Action="Y" Title="Set Notch Center to 3000 Hz." > | |
| <STEP Action="S" Value="3000" Param="NotchCenter"></STEP> | |
| </ADJUSTMENT> | |
| <ADJUSTMENT Row="1" Action="Y" Title="Move High Cut to the left." > | |
| <STEP Action="D" IncBy="-2" Param="HighCut"></STEP> | |
| </ADJUSTMENT> | |
| </ISSUE> | |
| </CIRCUIT> | |
| |
| </code> | <html> |
| | <table border="1" cellpadding="1" cellspacing="0" width="700" class="inline"> |
| | <tbody><tr> |
| | <th>fittingguide.xml</th> |
| | </tr> |
| | |
| | <tr> |
| | <td><p><tt><font color="#ff0000"><CIRCUIT Code="FOUNDATION" Title="FOUNDATION"></font><br> |
| | |
| | <ISSUE Title="FEEDBACK"><br> |
| | <ADJUSTMENTS Code="FOUNDATION FEEDBACK |
| | (Constant)"><br> |
| | |
| | <ADJUSTMENT Row="0" Action="Y" |
| | Title="Set Notch Center to 3000 Hz." ><br> |
| | <STEP Action="S" Value="3000" |
| | Param="NotchCenter"></STEP><br> |
| | |
| | </ADJUSTMENT><br> |
| | |
| | <ADJUSTMENT Row="1" Action="Y" |
| | Title="Move High Cut to the left." ><br> |
| | <STEP Action="D" IncBy="-2" |
| | Param="HighCut"></STEP><br> |
| | |
| | </ADJUSTMENT><br> |
| | </ISSUE><br> |
| | <font color="#ff0000"></CIRCUIT</font></tt><font color="#ff0000"><tt>></tt></font><tt><br> |
| | |
| | </tt></p> |
| | </td> |
| | </tr> |
| | </tbody></table> |
| | <p> |
| | </html> |
| | |
| | |
| | === Define an Issue === |
| | |
| | Element Name: **<ISSUES ...>**<ISSUE...>...</ISSUE>**</ISSUES>** |
| | |
| | Use <ISSUES>...</ISSUES> when there are several issues (or sub-issues) under the same issue. Otherwise, it is not used, and <ISSUE>..</ISSUE> is used directly. |
| | |
| | Parameters to be used: |
| | |
| | * Title: Title (full name) of the issues category to display. |
| | |
| | Requirements: |
| | |
| | * Must belong to a Circuit. |
| | * Must contain at least one Adjustment. |
| | |
| | Example ''fittingguide.xml'' file: |
| | <html> |
| | <table border="1" cellpadding="1" cellspacing="0" width="700" class="inline"> |
| | <tbody><tr> |
| | <th>fittingguide.xml</th> |
| | </tr> |
| | <tr> |
| | <td><p><tt><font color="#ff0000"><CIRCUIT Code="FOUNDATION" Title="FOUNDATION"><br> |
| | |
| | </font></tt><tt> <font color="#ff0000"><ISSUES Title="Feedback"></font><br> |
| | <font color="#ff0000"><ISSUE Title="Feedback |
| | (Constant)"></font><br> |
| | |
| | <ADJUSTMENTS Code="FOUNDATION |
| | Feedback (Constant)"><br> |
| | <ADJUSTMENT Row="0" |
| | Action="Y" Title="Set Notch Center to 3000 Hz." ><br> |
| | |
| | <STEP Action="S" |
| | Value="3000" Param="NotchCenter"></STEP><br> |
| | </ADJUSTMENT><br> |
| | <ADJUSTMENT Row="1" |
| | Action="Y" Title="Move High Cut to the left." ><br> |
| | |
| | <STEP Action="D" |
| | IncBy="-2" Param="HighCut"></STEP><br> |
| | </ADJUSTMENT><br> |
| | </tt><tt><font color="#ff0000"></font></tt><tt> </ADJUSTMENTS><br> |
| | |
| | </tt><tt> <font color="#ff0000"></ISSUE></font><br> |
| | <font color="#ff0000"></ISSUES></font> <br> |
| | |
| | </CIRCUIT></tt></p> |
| | </td> |
| | </tr> |
| | </tbody></table> |
| | |
| | </html> |
| |
| === Define an Adjustment === | === Define an Adjustment === |
| Parameters to be used: | Parameters to be used: |
| |
| * ADJUSTMENTS (plural) Code: Code string for a category of Adjustments, rather than a single adjustment. It cannot have other adjustment parameters. Note: This code string is composed of CircuitCode + IssueTitle, and it is case sensitive. For example: if the Circuit Code is "P2" (case sensitive), and the Issue Title is "Feedback" (case sensitive), then the Adjustments Code would be "P2 Feedback". See the code:<code xml> | * ADJUSTMENTS (plural) Code: Code string for a category of Adjustments, rather than a single adjustment. It cannot have other adjustment parameters. Note: This code string is composed of CircuitCode + IssueTitle, and it is case sensitive. For example: if the Circuit Code is "P2" (case sensitive), and the Issue Title is "Feedback" (case sensitive), then the Adjustments Code would be "P2 Feedback". See the code:<html> |
| <CIRCUIT Code="P2" Title="Paragon 2"> | <table border="1" cellpadding="1" cellspacing="0" width="600" class="inline"> |
| <ISSUE Title="Feedback"> | <tbody><tr> |
| <ADJUSTMENTS Code="P2 Feedback"> | <td><tt><CIRCUIT Code="P2" Title="Paragon 2"><br> |
| ...some adjustments here... | <ISSUE Title="Feedback"><br> |
| </ADJUSTMENTS> | <ADJUSTMENTS <font color="#ff0000">Code="P2 Feedback"</font>><br> |
| </ISSUE> | |
| </CIRCUIT> | ...some adjustments here...<br> |
| </code> | |
| | </ADJUSTMENTS><br> |
| | </ISSUE><br> |
| | </CIRCUIT></tt></td> |
| | </tr> |
| | </tbody></table> |
| | </html> |
| * ADJUSTMENT (singular) Row: row number in which it will be displayed. Each adjustment must start with row 0. | * ADJUSTMENT (singular) Row: row number in which it will be displayed. Each adjustment must start with row 0. |
| * ADJUSTMENT (singular) Action: One of the following: | * ADJUSTMENT (singular) Action: One of the following: |
| |
| Example ''fittingguide.xml'' file: | Example ''fittingguide.xml'' file: |
| <code xml> | <html> |
| <CIRCUIT Code="P2" Title="Paragon 2"> | <table border="1" cellpadding="1" cellspacing="0" width="100%" class="inline"> |
| <ISSUE Title="Loud Sounds Uncomfortable"> | <tbody><tr> |
| <ADJUSTMENTS Code="P2 Loud Sounds Uncomfortable"> | <th>fittingguide.xml</th> |
| <ADJUSTMENT Row="0" Action="Y" Title="Reduce overall MPO"> | </tr> |
| <STEP Action="D" IncBy="-2" Param="AGCO"></STEP> | <tr> |
| </ADJUSTMENT> | <td><p><tt><CIRCUIT Code="P2" Title="Paragon 2"><br> |
| <ADJUSTMENT Row="1" Action="Y" Title="Reduce Loud TK,Increase Soft TK in all Channels" > | |
| <STEP Action="ED" IncBy="-2" GTE="LTH1" EQU="UTH1-LTH1[GT]LLGAIN1-HLGAIN1" Param="UTH1"></STEP> | <ISSUE Title="Loud Sounds Uncomfortable"><br> |
| <STEP Action="ED" IncBy="-2" GTE="LTH2" EQU="UTH2-LTH2[GT]LLGAIN2-HLGAIN2" Param="UTH2"></STEP> | <font color="#006600"><ADJUSTMENTS Code="P2 Loud Sounds |
| <STEP Action="EI" IncBy="1" LTE="UTH1" EQU="UTH1-LTH1[GT]LLGAIN1-HLGAIN1" Param="LTH1"></STEP> | Uncomfortable"></font><br> |
| <STEP Action="EI" IncBy="1" LTE="UTH2" EQU="UTH2-LTH2[GT]LLGAIN2-HLGAIN2" Param="LTH2"></STEP> | <font color="#ff0000"><ADJUSTMENT Row="0" |
| </ADJUSTMENT> | Action="Y" Title="Reduce overall MPO"></font><br> |
| <ADJUSTMENT Row="2" Action="N" Title=""></ADJUSTMENT> | |
| <ADJUSTMENT Row="3" Action="N" Title="TIPS"></ADJUSTMENT> | <STEP Action="D" IncBy="-2" |
| <ADJUSTMENT Row="4" Action="N" Title="These solutions apply only to loud sounds."></ADJUSTMENT> | Param="AGCO"></STEP><br> |
| <ADJUSTMENT Row="5" Action="N" Title="Please see solutions for (overall too loud) if necessary."></ADJUSTMENT> | <font color="#ff0000"> </ADJUSTMENT><br> |
| </ADJUSTMENTS> | |
| </ISSUE> | <ADJUSTMENT Row="1" Action="Y" |
| </CIRCUIT> | Title="Reduce Loud TK,Increase Soft TK in all Channels" ></font><br> |
| </code> | |
| | <STEP Action="ED" IncBy="-2" |
| | GTE="LTH1" EQU="UTH1-LTH1[GT]LLGAIN1-HLGAIN1" Param="UTH1"></STEP><br> |
| | |
| | <STEP Action="ED" IncBy="-2" |
| | GTE="LTH2" EQU="UTH2-LTH2[GT]LLGAIN2-HLGAIN2" Param="UTH2"></STEP><br> |
| | |
| | <STEP Action="EI" IncBy="1" |
| | LTE="UTH1" EQU="UTH1-LTH1[GT]LLGAIN1-HLGAIN1" Param="LTH1"></STEP><br> |
| | |
| | <STEP Action="EI" IncBy="1" |
| | LTE="UTH2" EQU="UTH2-LTH2[GT]LLGAIN2-HLGAIN2" Param="LTH2"></STEP><br> |
| | |
| | <font color="#ff0000"> </ADJUSTMENT><br> |
| | <ADJUSTMENT Row="2" Action="N" |
| | Title=""></ADJUSTMENT><br> |
| | <ADJUSTMENT Row="3" Action="N" |
| | Title="TIPS"></ADJUSTMENT><br> |
| | |
| | <ADJUSTMENT Row="4" Action="N" |
| | Title="These solutions apply only to loud sounds."></ADJUSTMENT><br> |
| | <ADJUSTMENT Row="5" Action="N" |
| | Title="Please see solutions for (overall too loud) if necessary."></ADJUSTMENT></font><br> |
| | |
| | <font color="#006600"></ADJUSTMENTS></font><br> |
| | </ISSUE><br> |
| | </CIRCUIT> <br> |
| | |
| | </tt></p></td> |
| | </tr> |
| | </tbody></table> |
| | </html> |
| |
| === Define a Step === | === Define a Step === |
| |
| Example ''fittingguide.xml'' file: | Example ''fittingguide.xml'' file: |
| <code xml> | <html> |
| <ISSUE Title="OVERALL TOO LOUD"> | <p>Example:</p> |
| <ADJUSTMENTS Code="P2 OVERALL TOO LOUD"> | |
| <ADJUSTMENT Row="0" Action="Y" Title="Reduce overall gain/volume control" > | <table border="1" cellpadding="1" cellspacing="0" width="100%" class="inline"> |
| <STEP Action="D" IncBy="-1" Param="ExternalVC,WidebandGain;VC"></STEP> | <tbody><tr> |
| </ADJUSTMENT> | <th>fittingguide.xml</th> |
| <ADJUSTMENT Row="1" Action="Y" Title="Reduce Loud Gain in all channels"> | |
| <STEP Action="ED" IncBy="-2" EQU="UTH1-LTH1[GT]LLGAIN1-HLGAIN1" Param="HLGAIN1"></STEP> | </tr> |
| <STEP Action="ED" IncBy="-2" EQU="UTH2-LTH2[GT]LLGAIN2-HLGAIN2" Param="HLGAIN2"></STEP> | <tr> |
| </ADJUSTMENT> | <td><p><tt><ISSUE Title="OVERALL TOO LOUD"><br> |
| </ADJUSTMENTS> | <ADJUSTMENTS Code="P2 OVERALL TOO LOUD"><br> |
| </ISSUE> | <ADJUSTMENT Row="0" Action="Y" |
| </code> | Title="Reduce overall gain/volume control" ><br> |
| | |
| | <font color="#ff0000"> <STEP Action="D" |
| | IncBy="-1" Param="ExternalVC,WidebandGain;VC"></STEP><br> |
| | |
| | </font> </ADJUSTMENT><br> |
| | <ADJUSTMENT Row="1" Action="Y" |
| | Title="Reduce Loud Gain in all channels"><br> |
| | |
| | <font color="#ff0000"> <STEP Action="ED" |
| | IncBy="-2" EQU="UTH1-LTH1[GT]LLGAIN1-HLGAIN1" Param="HLGAIN1"></STEP><br> |
| | <STEP Action="ED" IncBy="-2" |
| | EQU="UTH2-LTH2[GT]LLGAIN2-HLGAIN2" Param="HLGAIN2"></STEP><br> |
| | |
| | </font> </ADJUSTMENT><br> |
| | |
| | </ADJUSTMENTS><br> |
| | </ISSUE><br> |
| | </tt></p></td> |
| | </tr> |
| | </tbody></table> |
| | </html> |
| |
| === Conditional Values based on Immediate IF (aka. inline IF) === | === Conditional Values based on Immediate IF (aka. inline IF) === |
| |
| Example: | Example: |
| <code xml> | <html> |
| <STEP Action="D" IncBy="-1" Param="ExternalVC,WidebandGain;VC"></STEP> | <tt><STEP Action="D" IncBy="-1" <font color="#ff0000">Param="ExternalVC,WidebandGain;VC"</font>></STEP></tt> |
| </code> | </html> |
| | |
| |
| == Original HTML Page == | == ezFIT 5.x Platform == |
| | * Add support for localization. For example: |
| <html> | <html> |
| <head> | <table border="1" cellpadding="1" cellspacing="0" width="700" class="inline"> |
| <title>ezFIT - Fitting Guide XML Format and Parameters</title> | <tbody><tr> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> | <th>Sample File Structure in ezFIT 5.x</th> |
| <link href="style.css" rel="stylesheet" type="text/css"> | |
| </head> | |
| | |
| <body> | |
| <h3>Fitting Guide - XML Format and Parameters</h3> | |
| <p>The Fitting Guide file (data\fittingguide.xml) provides an automated way to | |
| adjust parameters based on proven adjustment settings, thus saving a lot of | |
| time, and getting consistent results. These settings are stored in an XML format, | |
| so that it can be easily adjusted or edited if necessary. Each file can contain | |
| several products (circuits) and their respective settings. Following are the | |
| different formats to express the different settings providing the information | |
| that the software uses for fitting hearing instruments.</p> | |
| <p><strong>Basic Structure</strong></p> | |
| <table width="700" border="1" cellspacing="0" cellpadding="1"> | |
| | |
| <tr> | |
| <th>Sample File Structure</th> | |
| </tr> | </tr> |
| <tr> | <tr> |
| <td><?xml version="1.0" encoding="UTF-8"?><br> | <td><?xml version="1.0" encoding="UTF-8"?><br> |
| | |
| | <PROJECT><br> <CIRCUIT Code="<em>circuitcode</em>" |
| | Title="Instrument Model: <em>intrument model</em>"><br> |
| |
| <PROJECT><br> <CIRCUIT Code="<em>circuitcode</em>" | |
| Title="Instrument Model: <em>intrument model</em>"><br> | |
| <br> | <br> |
| <ISSUES Title="Subtitle 1"><br> | <ISSUES Title="Subtitle 1"><br> |
| <ISSUE Title="Subtitle A of Subtitle 1 "><br> | <ISSUE Title="Subtitle A of Subtitle 1 "><br> |
| <ADJUSTMENTS Code="<em>circuitcode</em> | <ADJUSTMENTS Code="<em>circuitcode</em> |
| Adjustments Set I"><br> | Adjustments Set I"><br> |
| <ADJUSTMENT Row="0" Action="Y" Title="<em>Action | <ADJUSTMENT Row="0" Action="Y" Title="<em>Action |
| Description</em>" > <br> | Description</em>" > <br> |
| </ADJUSTMENTS><br> </ISSUE><br> | </ADJUSTMENTS><br> </ISSUE><br> |
| </ISSUES><br> | </ISSUES><br> |
| <ISSUE Title="Subtitle B of Subtitle 1 "><br> | <ISSUE Title="Subtitle B of Subtitle 1 "><br> |
| <ADJUSTMENTS Code="<em>circuitcode</em> | <ADJUSTMENTS Code="<em>circuitcode</em> |
| Adjustments Set II"><br> | Adjustments Set II"><br> |
| <ADJUSTMENT Row="1" Action="Y" Title="<em>Action | <ADJUSTMENT Row="1" Action="Y" Title="<em>Action |
| Description</em>" > <br> | Description</em>" > <br> |
| </ADJUSTMENTS><br> </ISSUE><br> | </ADJUSTMENTS><br> </ISSUE><br> |
| </ISSUES><br> <br> | </ISSUES><br> <br> |
| <ISSUES Title="Subtitle 2"><br> | <ISSUES Title="Subtitle 2"><br> |
| <ISSUE Title="Subtitle A of Subtitle 2"><br> | <ISSUE Title="Subtitle A of Subtitle 2"><br> |
| <ADJUSTMENTS Code="<em>circuitcode</em> | <ADJUSTMENTS Code="<em>circuitcode</em> |
| Adjustments Set III"><br> | Adjustments Set III"><br> |
| <ADJUSTMENT Row="0" Action="Y" Title="<em>Action | <ADJUSTMENT Row="0" Action="Y" Title="<em>Action |
| Description</em>" > <br> | Description</em>" > <br> |
| </ADJUSTMENTS><br> </ISSUE><br> | </ADJUSTMENTS><br> </ISSUE><br> |
| </ISSUES><br> <br> </CIRCUIT><br> | </ISSUES><br> <br> </CIRCUIT><br> |
| |
| </tr> | </tr> |
| </table> | </tbody></table> |
| <h4>Element Descriptions and Attributes</h4> | </html> |
| <table width="100%" border="1" cellpadding="1" cellspacing="0"> | |
| <tr> | |
| <th width="24%">Element</th> | |
| <th width="21%">Attribute</th> | |
| <th width="55%">Description</th> | |
| </tr> | |
| |
| <tr valign="top"> | <html> |
| <td><PROJECT>...</PROJECT></td> | <table border="1" cellpadding="1" cellspacing="0" width="700" class="inline"> |
| <td> </td> | <tbody><tr> |
| <td>Container for all circuits. It is the main file definition, the parent | <th>Sample File Structure in ezFIT 5.x</th> |
| container for all elements.</td> | |
| </tr> | </tr> |
| <tr valign="top"> | |
| <td><CIRCUIT>...</CIRCUIT></td> | |
| |
| <td> </td> | |
| <td>Container for a circuit definition, the parent container for <ISSUES> | |
| and/or <ISSUE> elements. </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>Code="<em>CircuitCode</em>" </td> | |
| |
| <td>Code of circuit. This identifies and differentiates adjustments that might | |
| have the same name.</td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>Title="<em>InstrumentModel</em>"</td> | |
| <td>Name or title (to be displayed) for the circuit </td> | |
| </tr> | |
| |
| <tr valign="top"> | |
| <td><ISSUES>...</ISSUES></td> | |
| <td> Title="<em>subtitle</em>"</td> | |
| <td>Container for several issues. Required only if defining 2 or more issues. | |
| For a single issue, simply use element <ISSUE> directly, without defining | |
| it within <ISSUES>...</ISSUES> elements.</td> | |
| |
| </tr> | |
| <tr valign="top"> | |
| <td><ISSUE>...</ISSUE></td> | |
| <td> Title="<em>subtitle</em>"</td> | |
| <td>Container for a single issue, which contains one or more adjustments. | |
| Title displays a description of the issue.</td> | |
| </tr> | |
| |
| <tr valign="top"> | |
| <td><ADJUSTMENTS>...</ADJUSTMENTS><br> </td> | |
| <td>Code="<em>CircuitCode</em> <em>AdjName</em>"</td> | |
| <td>Container for serveral adjustments. <em>CircuitCode</em> must the the | |
| same code defined in <CIRCUIT>. <em>AjdName</em> can be any string | |
| that best describes the adjustment.</td> | |
| |
| </tr> | |
| <tr valign="top"> | |
| <td><ADJUSTMENT>... </ADJUSTMENT> </td> | |
| <td> </td> | |
| <td>Container for a single adjustment, which could contains zero or more <STEP> | |
| elements. </td> | |
| |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td> Row="<em>RowNumber</em>" </td> | |
| <td>Row (order) where to display it. Row numbering starts with 0. Eg: Row="0"</td> | |
| </tr> | |
| |
| <tr valign="top"> | |
| <td> </td> | |
| <td>Action="<em>val</em>" </td> | |
| <td><em>val</em> can be one of these: | |
| <table width="85%" border="1" align="center" cellpadding="1" cellspacing="0"> | |
| <tr valign="top" bgcolor="#FFFFFF"> | |
| <td width="8%">Y</td> | |
| |
| <td width="92%">Take action. <br> | |
| Eg: <ADJUSTMENT Row="1" Action="Y" Title="Set | |
| Gain">..</ADJUSTMENT></td> | |
| </tr> | |
| |
| <tr valign="top" bgcolor="#FFFFFF"> | |
| <td>N</td> | |
| <td>Take No action. Use this to simply display the specified title (with | |
| no action associated with it). <br> | |
| Eg: <ADJUSTMENT Row="3" Action="N" Title="TIPS"/></td> | |
| |
| </tr> | |
| </table> | |
| | |
| </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>Title="<em>Action Description</em>" </td> | |
| <td>Title to display in row.</td> | |
| |
| </tr> | |
| <tr valign="top"> | |
| <td> <STEP/><br></td> | |
| <td> </td> | |
| <td>Container for a single step in an adjustment.</td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| |
| <td>Action="<em>val</em>"</td> | |
| <td><em>val</em> can be one of these:<br> | |
| <table width="85%" border="1" align="center" cellpadding="1" cellspacing="0"> | |
| <tr valign="top" bgcolor="#FFFFFF"> | |
| <td width="8%">I</td> | |
| <td width="92%">Increase.</td> | |
| |
| </tr> | |
| <tr valign="top" bgcolor="#FFFFFF"> | |
| <td>D</td> | |
| <td>Decrease.</td> | |
| </tr> | |
| <tr valign="top" bgcolor="#FFFFFF"> | |
| <td>EI</td> | |
| <td>Equation Increase.</td> | |
| |
| </tr> | |
| <tr valign="top" bgcolor="#FFFFFF"> | |
| <td>ED</td> | |
| <td>Equation Decrease.</td> | |
| </tr> | |
| <tr valign="top" bgcolor="#FFFFFF"> | |
| <td>S</td> | |
| <td>Set a single value. Use with Value parameter.</td> | |
| |
| </tr> | |
| <tr valign="top" bgcolor="#FFFFFF"> | |
| <td>RI</td> | |
| <td> Range Increase.</td> | |
| </tr> | |
| <tr valign="top" bgcolor="#FFFFFF"> | |
| <td>RD</td> | |
| <td> Range Decrease.</td> | |
| |
| </tr> | |
| <tr valign="top" bgcolor="#FFFFFF"> | |
| <td>RS</td> | |
| <td> Range Set. Use with SetValues parameter.</td> | |
| </tr> | |
| </table></td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| |
| <td> IncBy="<em>numval</em>"</td> | |
| <td><em>numval</em> can be a positive or negative integer.</td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>SetValues="[<em>x1</em>,<em>x2</em>,<em>x3</em>,...,<em>xN</em>]"</td> | |
| |
| <td>Set Range values. Use with Action="RS". Eg: SetValues="[5600,4500,4000]"</td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>Value="<em>val</em>"</td> | |
| <td>Set a single value. Use with Action="S". Eg: Value="Dynamic"</td> | |
| |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>GT="<em>param2</em>"</td> | |
| <td>Greater Than. If <em>param1 </em>> <em>param2</em>, perform Action. | |
| <em>param1</em> would be the value of parameter <em>ParamName</em> specified | |
| in attribute Param. Use in conjunction with EQU attribute.<br> | |
| |
| Eg: <STEP Action="ED" IncBy="-2" GT="LTH4" | |
| EQU="UTH4[GTE]LTH4" Param="UTH4"/></td> | |
| |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>LT="<em>param2</em>"</td> | |
| <td>Lesser Than. If <em>param1 </em>< <em>param2</em>, perform Action. | |
| <em>param1</em> would be the value of parameter <em>ParamName</em> specified | |
| in attribute Param. Use in conjunction with EQU attribute.<br> | |
| |
| Eg: <STEP Action="ED" IncBy="-2" LT="max" | |
| EQU="min[LT]max" Param="min"/></td> | |
| |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>EQ="<em>param2</em>"</td> | |
| <td>Equal To. If <em>param1 </em>>= <em>param2</em>, perform Action. <em>param1</em> | |
| would be the value of parameter <em>ParamName</em> specified in attribute | |
| Param. Use in conjunction with EQU attribute.</td> | |
| |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>GTE="<em>param2</em>"</td> | |
| <td>Greater Than or Equal To. If <em>param1 </em>>= <em>param2</em>, perform | |
| Action. <em>param1</em> would be the value of parameter <em>ParamName</em> | |
| specified in attribute Param. Use in conjunction with EQU attribute.<br> | |
| |
| Eg: <STEP Action="ED" IncBy="-2" GTE="LTH4" | |
| EQU="UTH4[GTE]LTH4" Param="UTH4"/></td> | |
| |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>LTE="<em>param2</em>"</td> | |
| <td>Less Than or Equal To. If <em>param1 </em><= <em>param2</em>, perform | |
| Action. <em>param1</em> would be the value of parameter <em>ParamName</em> | |
| specified in attribute Param. Use in conjunction with EQU attribute.<br> | |
| |
| Eg: <STEP Action="ED" IncBy="-2" LTE="max" | |
| EQU="min[LTE]max" Param="min"/> </td> | |
| |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>PEQU="<em>ProposedEquation</em>"</td> | |
| <td> Proposed Equation. The Proposed value uses the new value of the current | |
| parameter Param to calculate the equation. In other words, perform Action, | |
| evaluate equation, and if it is True, permanently store the results of performed | |
| Action. Eg: <br> | |
| <STEP Action="EI" IncBy="1" PEQU="SquelchTh[LT]50" | |
| Param="SquelchTh"/></td> | |
| |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>EQU="<em>equation</em>"</td> | |
| <td>Equation. Perform Action if equation is True. Eg: EQU="UTH3-LTH3[GT]LLGAIN3-HLGAIN3"<br> | |
| <br> | |
| Comparison Operators inside of defined equations:<br> | |
| |
| [GTE]=Greater Than and Equal To<br> | |
| [LTE]=Lesser Than and Equal To<br> | |
| [EQ]=Equal To<br> | |
| [GT]=Greater Than<br> | |
| [LT]=Lesser Than </td> | |
| </tr> | |
| |
| <tr valign="top"> | |
| <td> </td> | |
| <td> Param="<em>ParamName</em>"</td> | |
| <td><em>ParamName</em> is a parameter name supported by the circuit. Eg: HFC, | |
| LFC, TK </td> | |
| </tr> | |
| </table> | |
| |
| <h4>How to Define Sections</h4> | |
| |
| <p><strong>Define a Product</strong></p> | |
| <p>Element Name: <CIRCUIT ...>...</CIRCUIT></p> | |
| <p>Parameters to be used:</p> | |
| <ul> | |
| <li>Code: Name (code) of the product.</li> | |
| <li>Title: Title (full name) of the product.</li> | |
| </ul> | |
| |
| <p>Requirements:</p> | |
| <ul> | |
| <li>Must contain at least one Issue.</li> | |
| </ul> | |
| <p>Example:</p> | |
| <table width="700" border="1" cellspacing="0" cellpadding="1"> | |
| <tr> | <tr> |
| <th>fittingguide.xml</th> | <td> |
| </tr> | <pre> |
| | <code><span style="font: 10pt Courier New;"><span class="pas1-symbol"><?xml version="1.0" encoding="UTF-8"?> |
| | <PROJECT> |
| | <font color="#ff0000"><languages> |
| | <lang id="en" name="English (US)">English</lang> |
| | <lang id="fr" name="French">Français</lang> |
| | <lang id="pt" name="Portuguese">Português</lang> |
| | <lang id="es" name="Spanish">Español</lang> |
| | <lang id="da" name="Danish">Dansk</lang> |
| | <lang id="tr" name="Turkish">Türkçe</lang> |
| | <lang id="ru" name="Russian">??????</lang> |
| | <lang id="cn" name="Chinese (Mandarin)">??</lang> |
| | </languages></font> |
| | <CIRCUIT Code="circuitcode" Title="Instrument Model: intrument model"> |
| | <font color="#ff0000"> |
| | <native>Instrument Model: intrument model</native> |
| | <lang id="es">Modelo de Audífono: Model de Audífono</lang> |
| | <lang id="fr">...</lang> |
| | ... |
| | </font> |
| | <ISSUES Title="Subtitle 1"> |
| | <font color="#ff0000"> |
| | <native>Subtitle 1</native> |
| | <lang id="es">Subtítulo 1</lang> |
| | <lang id="fr">...</lang> |
| | ... |
| | </font> |
| | <ISSUE Title="Subtitle A </span><span class="pas1-reservedword">of</span><span class="pas1-space"> Subtitle 1"> |
| | <font color="#ff0000"> |
| | <native>Subtitle A </span><span class="pas1-reservedword">of</span><span class="pas1-space"> Subtitle 1</native> |
| | <lang id="es">Subtítulo A de Subtítulo 1</lang> |
| | <lang id="fr">...</lang> |
| | ... |
| | </font> |
| | <ADJUSTMENTS Code="circuitcode Adjustments </span><span class="pas1-reservedword">Set</span><span class="pas1-space"> I"> |
| | <font color="#ff0000"> |
| | <native>Adjustments </span><span class="pas1-reservedword">Set</span><span class="pas1-space"> I</native> |
| | <lang id="es">Ajuste Conjunto I</lang> |
| | <lang id="fr">...</lang> |
| | ... |
| | </font> |
| | <ADJUSTMENT Row="0" Action="Y" Title="Action Description" > |
| | <font color="#ff0000"> |
| | <native>Action Description</native> |
| | <lang id="es">Descripción de Accción</lang> |
| | <lang id="fr">...</lang> |
| | ... |
| | </font> |
| | </ADJUSTMENTS> |
| | </ISSUE> |
| | </ISSUES> |
| | <ISSUE Title="Subtitle B </span><span class="pas1-reservedword">of</span><span class="pas1-space"> Subtitle 1 "> |
| | <ADJUSTMENTS Code="circuitcode Adjustments </span><span class="pas1-reservedword">Set</span><span class="pas1-space"> II"> |
| | <ADJUSTMENT Row="1" Action="Y" Title="Action Description" > |
| | </ADJUSTMENTS> |
| | </ISSUE> |
| | </ISSUES> |
| |
| <tr> | <ISSUES Title="Subtitle 2"> |
| <td><p><tt><font color="#FF0000"><CIRCUIT Code="FOUNDATION" Title="FOUNDATION"></font><br> | <ISSUE Title="Subtitle A </span><span class="pas1-reservedword">of</span><span class="pas1-space"> Subtitle 2"> |
| <ISSUE Title="FEEDBACK"><br> | <ADJUSTMENTS Code="circuitcode Adjustments </span><span class="pas1-reservedword">Set</span><span class="pas1-space"> III"> |
| <ADJUSTMENTS Code="FOUNDATION FEEDBACK | <ADJUSTMENT Row="0" Action="Y" Title="Action Description" > |
| (Constant)"><br> | </ADJUSTMENTS> |
| | </ISSUE> |
| | </ISSUES> |
| |
| <ADJUSTMENT Row="0" Action="Y" | </CIRCUIT> |
| Title="Set Notch Center to 3000 Hz." ><br> | </PROJECT> |
| <STEP Action="S" Value="3000" | </span></span> |
| Param="NotchCenter"></STEP><br> | </code></pre> |
| | </td></tr></table> |
| </ADJUSTMENT><br> | |
| <ADJUSTMENT Row="1" Action="Y" | |
| Title="Move High Cut to the left." ><br> | |
| <STEP Action="D" IncBy="-2" | |
| Param="HighCut"></STEP><br> | |
| | |
| </ADJUSTMENT><br> | |
| </ISSUE><br> | |
| <font color="#FF0000"></CIRCUIT</font></tt><font color="#FF0000"><tt>></tt></font><tt><br> | |
| </tt></p> | |
| </td> | |
| </tr> | |
| </table> | |
| <p><strong>Define an Issue</strong></p> | |
| | |
| <p>Element Name: <ISSUE<strong>S</strong> ...><ISSUE...>...</ISSUE></ISSUE<strong>S</strong>><br> | |
| Use <ISSUES>...</ISSUES> when there are several issues (or sub-issues) | |
| under the same issue. Otherwise, it is not used, and <ISSUE>..</ISSUE> | |
| is used directly.</p> | |
| | |
| <p>Parameters to be used:</p> | |
| <ul> | |
| <li>Title: Title (full name) of the issues category to display.</li> | |
| </ul> | |
| <p>Requirements:</p> | |
| <ul> | |
| <li>Must belong to a Circuit.</li> | |
| <li>Must contain at least one Adjustment.</li> | |
| </ul> | |
| | |
| <p>Example:</p> | |
| <table width="700" border="1" cellpadding="1" cellspacing="0"> | |
| <tr> | |
| <th>fittingguide.xml</th> | |
| </tr> | |
| <tr> | |
| <td><p><tt><font color="#FF0000"><CIRCUIT Code="FOUNDATION" Title="FOUNDATION"><br> | |
| | |
| </font></tt><tt> <font color="#FF0000"><ISSUES Title="Feedback"></font><br> | |
| <font color="#FF0000"><ISSUE Title="Feedback | |
| (Constant)"></font><br> | |
| <ADJUSTMENTS Code="FOUNDATION | |
| Feedback (Constant)"><br> | |
| <ADJUSTMENT Row="0" | |
| Action="Y" Title="Set Notch Center to 3000 Hz." ><br> | |
| | |
| <STEP Action="S" | |
| Value="3000" Param="NotchCenter"></STEP><br> | |
| </ADJUSTMENT><br> | |
| <ADJUSTMENT Row="1" | |
| Action="Y" Title="Move High Cut to the left." ><br> | |
| | |
| <STEP Action="D" | |
| IncBy="-2" Param="HighCut"></STEP><br> | |
| </ADJUSTMENT><br> | |
| </tt><tt><font color="#FF0000"></font></tt><tt> </ADJUSTMENTS><br> | |
| | |
| </tt><tt> <font color="#FF0000"></ISSUE></font><br> | |
| <font color="#FF0000"></ISSUES></font> <br> | |
| </CIRCUIT></tt></p> | |
| </td> | |
| </tr> | |
| </table> | |
| <p><strong>Define an Adjustment</strong></p> | |
| | |
| <p>Element Name: <ADJUSTMENT<strong>S</strong>...><ADJUSTMENT...>...</ADJUSTMENT></ADJUSTMENT<strong>S</strong>></p> | |
| <p>Parameters to be used:</p> | |
| <ul> | |
| <li>ADJUSTMENTS (plural) Code: Code string for a category of Adjustments, rather | |
| than a single adjustment. It cannot have other adjustment parameters.<br> | |
| <br> | |
| | |
| <strong>Note</strong>: This code string is composed of <em>CircuitCode</em> | |
| + <em>IssueTitle</em>, and it is case sensitive. <br> | |
| For example: if the Circuit Code is "P2" (case sensitive), and the | |
| Issue Title is "Feedback" (case sensitive), then the Adjustments | |
| Code would be "P2 Feedback". See the code:<br> | |
| | |
| <table width="600" border="1" cellspacing="0" cellpadding="1"> | |
| <tr> | |
| <td><tt><CIRCUIT Code="P2" Title="Paragon 2"><br> | |
| <ISSUE Title="Feedback"><br> | |
| <ADJUSTMENTS <font color="#FF0000">Code="P2 Feedback"</font>><br> | |
| | |
| ...some adjustments here...<br> | |
| </ADJUSTMENTS><br> | |
| </ISSUE><br> | |
| </CIRCUIT></tt></td> | |
| </tr> | |
| </table> | |
| <br> | |
| | |
| </li> | |
| <li>ADJUSTMENT (singular) Row: row number in which it will be displayed. Each | |
| adjustment must start with row 0.</li> | |
| <li>ADJUSTMENT (singular) Action: One of the following: | |
| <ul> | |
| <li>Y: Yes, it performs an action. If Action=Y, then the adjustment must | |
| contain at least one Step.</li> | |
| <li>N: No, it does not perform an action. If Action=N, then there are no | |
| Steps included with the adjustment, since there is no action to perform.</li> | |
| </ul> | |
| </li> | |
| | |
| <li>ADJUSTMENT (singular) Title: Title or name to display for the adjustement.</li> | |
| </ul> | |
| <p>Requirements:</p> | |
| <ul> | |
| <li>Must belong to an Issue, or in the case of a sub-Adjustment, must belong | |
| to an Adjustment.</li> | |
| <li>May contain none, one or many Steps, depending on the parameters.</li> | |
| <li>In the case of a super-adjustment, it must contain at least one sub-Adjustment.</li> | |
| </ul> | |
| | |
| <p>Example:</p> | |
| <table width="100%" border="1" cellpadding="1" cellspacing="0"> | |
| <tr> | |
| <th>fittingguide.xml</th> | |
| </tr> | |
| <tr> | |
| <td><p><tt><CIRCUIT Code="P2" Title="Paragon 2"><br> | |
| | |
| <ISSUE Title="Loud Sounds Uncomfortable"><br> | |
| <font color="#006600"><ADJUSTMENTS Code="P2 Loud Sounds | |
| Uncomfortable"></font><br> | |
| <font color="#FF0000"><ADJUSTMENT Row="0" | |
| Action="Y" Title="Reduce overall MPO"></font><br> | |
| | |
| <STEP Action="D" IncBy="-2" | |
| Param="AGCO"></STEP><br> | |
| <font color="#FF0000"> </ADJUSTMENT><br> | |
| <ADJUSTMENT Row="1" Action="Y" | |
| Title="Reduce Loud TK,Increase Soft TK in all Channels" ></font><br> | |
| | |
| <STEP Action="ED" IncBy="-2" | |
| GTE="LTH1" EQU="UTH1-LTH1[GT]LLGAIN1-HLGAIN1" Param="UTH1"></STEP><br> | |
| | |
| <STEP Action="ED" IncBy="-2" | |
| GTE="LTH2" EQU="UTH2-LTH2[GT]LLGAIN2-HLGAIN2" Param="UTH2"></STEP><br> | |
| | |
| <STEP Action="EI" IncBy="1" | |
| LTE="UTH1" EQU="UTH1-LTH1[GT]LLGAIN1-HLGAIN1" Param="LTH1"></STEP><br> | |
| | |
| <STEP Action="EI" IncBy="1" | |
| LTE="UTH2" EQU="UTH2-LTH2[GT]LLGAIN2-HLGAIN2" Param="LTH2"></STEP><br> | |
| | |
| <font color="#FF0000"> </ADJUSTMENT><br> | |
| <ADJUSTMENT Row="2" Action="N" | |
| Title=""></ADJUSTMENT><br> | |
| <ADJUSTMENT Row="3" Action="N" | |
| Title="TIPS"></ADJUSTMENT><br> | |
| | |
| <ADJUSTMENT Row="4" Action="N" | |
| Title="These solutions apply only to loud sounds."></ADJUSTMENT><br> | |
| <ADJUSTMENT Row="5" Action="N" | |
| Title="Please see solutions for (overall too loud) if necessary."></ADJUSTMENT></font><br> | |
| | |
| <font color="#006600"></ADJUSTMENTS></font><br> | |
| </ISSUE><br> | |
| </CIRCUIT> <br> | |
| </tt></p></td> | |
| </tr> | |
| </table> | |
| <p><strong>Define a Step</strong></p> | |
| | |
| <p>Element Name: <STEP...>...</STEP></p> | |
| <p>Parameters to be used:</p> | |
| <ul> | |
| <li>Action: | |
| <ul> | |
| <li>I: Increase</li> | |
| <li>D: Decrease</li> | |
| | |
| <li>S: Set</li> | |
| <li>EI: Equation Increase</li> | |
| <li>ED: Equation Decrease</li> | |
| <li>RI: Range Increase</li> | |
| <li>RD: Range Decrease</li> | |
| <li>RS: Range Set</li> | |
| | |
| </ul> | |
| </li> | |
| <li>EQU: Equation to use. Used in conjunction with Action=EI or ED. Example:<br> | |
| <tt><STEP Action="EI" IncBy="1" LTE="UTH1" | |
| EQU="UTH1-LTH1[GT]LLGAIN1-HLGAIN1" Param="LTH1"></STEP></tt> | |
| </li> | |
| | |
| <li>GTE: "Grater Than or Equal To" the "Param" value in | |
| instrument. Example:<br> | |
| <tt><STEP Action="ED" IncBy="-2" GTE="LTH2" | |
| EQU="UTH2-LTH2[GT]LLGAIN2-HLGAIN2" Param="UTH2"></STEP></tt> | |
| </li> | |
| | |
| <li>LTE: "Less Than or Equal To" the "Param" value in instrument. | |
| Example:<br> | |
| <tt><STEP Action="EI" IncBy="1" LTE="UTH1" | |
| EQU="UTH1-LTH1[GT]LLGAIN1-HLGAIN1" Param="LTH1"></STEP></tt> | |
| </li> | |
| | |
| <li>IncBy: a positive integer to denote increase, a negative integeer to denote | |
| decrease. Used in conjunction with Action=I or D. Example:<br> | |
| <tt><STEP Action="D" IncBy="-2" Param="band9"></STEP><br> | |
| <STEP Action="I" IncBy="2" Param="ExternalVC,WidebandGain;VC"></STEP></tt> | |
| </li> | |
| | |
| <li>SetValues: set multiple values. Used in conjunction with Action=RS. Example:<br> | |
| <tt><STEP Action="RS" SetValues="[5600,4500,4000]" | |
| Param="HighCut"></STEP></tt> </li> | |
| <li>PEQU: Proposed equation setting. Use in conjunction with Action=EI. Example:<br> | |
| | |
| <tt><STEP Action="EI" IncBy="1" PEQU="SquelchTh[LT]50" | |
| Param="SquelchTh"></STEP></tt> </li> | |
| <li>Value: a value to set in the specified parameter. Used in conjunction with | |
| Action=S. </li> | |
| | |
| <li>Param: instrument parameter to be affected. Note: this is case sensitive. | |
| Example:<br> | |
| <tt><STEP Action="I" IncBy="2" Param="ExternalVC,WidebandGain;VC"></STEP></tt> | |
| </li> | |
| </ul> | |
| <p>Example:</p> | |
| | |
| <table width="100%" border="1" cellpadding="1" cellspacing="0"> | |
| <tr> | |
| <th>fittingguide.xml</th> | |
| </tr> | |
| <tr> | |
| <td><p><tt><ISSUE Title="OVERALL TOO LOUD"><br> | |
| <ADJUSTMENTS Code="P2 OVERALL TOO LOUD"><br> | |
| <ADJUSTMENT Row="0" Action="Y" | |
| Title="Reduce overall gain/volume control" ><br> | |
| | |
| <font color="#FF0000"> <STEP Action="D" | |
| IncBy="-1" Param="ExternalVC,WidebandGain;VC"></STEP><br> | |
| </font> </ADJUSTMENT><br> | |
| <ADJUSTMENT Row="1" Action="Y" | |
| Title="Reduce Loud Gain in all channels"><br> | |
| | |
| <font color="#FF0000"> <STEP Action="ED" | |
| IncBy="-2" EQU="UTH1-LTH1[GT]LLGAIN1-HLGAIN1" Param="HLGAIN1"></STEP><br> | |
| <STEP Action="ED" IncBy="-2" | |
| EQU="UTH2-LTH2[GT]LLGAIN2-HLGAIN2" Param="HLGAIN2"></STEP><br> | |
| | |
| </font> </ADJUSTMENT><br> | |
| </ADJUSTMENTS><br> | |
| </ISSUE><br> | |
| </tt></p></td> | |
| </tr> | |
| </table> | |
| <p><strong>Conditional Values based on Immediate IF (aka. inline IF)</strong></p> | |
| <p><tt>Param</tt> can contain a result derived from an immediate IF. This allows | |
| more flexibility in handling parameters.</p> | |
| | |
| <p>Format:<br> | |
| <tt>Param="<em>expression1, expression2; expression3</em>"</tt><br> | |
| If <em>expression1</em> is true, then use value from <em>expression2</em>, else | |
| use value from <em>expression3</em>.</p> | |
| <p> Example:<br> | |
| | |
| <tt><STEP Action="D" IncBy="-1" <font color="#FF0000">Param="ExternalVC,WidebandGain;VC"</font>></STEP></tt></p> | |
| <hr size="1"> | |
| <p> </p> | |
| </body> | |
| </html> | </html> |
| | * Modify behavior for Decrease (D) operator. |