<?xml version="1.0" encoding="UTF-8" ?>
<?xml-stylesheet type="text/xsl" href="../../Documentation.xsl"?>

<documentation>
	<extension-title>Tone Of Voice Assistant</extension-title>
	<extension-menu-doc>Menu.xml</extension-menu-doc>
	<content>
		<topic>
			
			<topic-title>Overview</topic-title>
			
			<topic-text>

				<p>
					The <i>Tone Of Voice Assistant</i> is a <i>Storefront Extension</i>.<br />
					When editing a document and entering text on the <i>Step</i> page,
					it notifies or blocks the user from ordering
					when they use a term that breaks tone of voice rules
					based on a <i>dictionary</i> and can also suggest alternative terms.
				</p>
				
			</topic-text>


			<topic-title>What does it do?</topic-title>
			
			<topic-text>

				<p>
					<i>Tone Of Voice Assistant</i> advises users
					when they use a word, phrase or format you would like to avoid
					and offers preferred alternatives,
					making every piece of writing consistent across your brand.
				</p>
				
			</topic-text>

		</topic>


		<topic>
			
			<topic-title>Release Notes</topic-title>
			
			<topic-text>

				<p>
					<h3>Version 3.17</h3>
					19/02/2025
					<ul>
						<li>
							Bug-fix - the <i>Usage</i> recording fixed.
						</li>
					</ul>					
				</p>

				<p>
					<h3>Version 3.16</h3>
					20/01/2025
					<ul>
						<li>
							Bug-fix - older format of the JSON data fully supported.
						</li>
					</ul>					
				</p>
				<p>
					<h3>Version 3.15</h3>
					16/01/2025
					<ul>
						<li>
							If a plural of a noun appears among the alternatives
							then it is not flagged as a word to avoid,
							even when its singular is in the dictionary.
						</li>
						<li>
							Bug-fix - the <i>date-fields</i> are excluded from the check.
						</li>
					</ul>					
				</p>
				<p>
					<h3>Version 3.14</h3>
					18/12/2024
					<ul>
						<li>Bug-fix - the conditionally visible text-fields are checked as they become visible.</li>
						<li>
							Bug-fix - a term to avoid which contains punctuation characters
							is flagged correctly regardless of context.
						</li>
					</ul>					
				</p>
				<p>
					<h3>Version 3.13</h3>
					07/11/2024
					<ul>
						<li>Added the <i>Options</i> menu item which configures the <i>Ignore</i> cases.</li>
						<li>The <i>HTML Injection</i> vulnerability suppressed on the <i>Admin</i> page.</li>
					</ul>					
				</p>
				<p>
					<h3>Version 3.12</h3>
					13/06/2024
					<ul>
						<li>The context of a suggestion is recorded.</li>
					</ul>					
				</p>
				<p>
					<h3>Version 3.11</h3>
					24/04/2024
					<ul>
						<li>Bug-fix - CSV file upload - empty expressions.</li>
					</ul>					
				</p>
				<p>
					<h3>Version 3.10</h3>
					29/12/2023
					<ul>
						<li>The <i>Admin Site</i> dictionary page is accessible to every admin.</li>
						<li>The <i>Alternatives</i> are edited right in the table row.</li>
						<li>A new <i>Preview</i> box is introduced - text is checked just like on the <i>User Site</i>.</li>
						<li>Introduced validation when adding new terms on the admin page.</li>
					</ul>					
				</p>
				<p>
					<h3>Version 3.9</h3>
					03/08/2023
					<ul>
						<li>A <i>Tip</i> can be added to each expression to avoid.</li>
						<li>The <i>Notification</i> and the <i>Tip</i> is edited right in the table row.</li>
						<li>Older exported CSV files with no <i>Tips</i> are accepted by the CSV import.</li>
					</ul>
				</p>
				<p>
					<h3>Version 3.8</h3>
					30/05/2023
					<ul>
						<li>The dictionary is blank after the extension is first installed.</li>
					</ul>
				</p>
				<p>
					<h3>Version 3.7</h3>
					20/04/2023
					<ul>
						<li>Punctuation characters are fully supported.</li>
						<li>Improved performance when checking larger quantities of text.</li>
					</ul>
				</p>
				<p>
					<h3>Version 3.6</h3>
					14/02/2023
					<ul>
						<li>
							The <i>full stop</i> and <i>hyphen</i> characters are now supported
							when they join words or form an abbreviation.
						</li>
					</ul>
				</p>
				<p>
					<h3>Version 3.5</h3>
					30/11/2022
					<ul>
						<li>Introduced a new event <i>Design Finalised With Amber Warning</i>.</li>
						<li>The <i>Warning Shown</i> event recorded only once per design and a text-field.</li>
					</ul>
				</p>
				<p>
					<h3>Version 3.4</h3>
					22/08/2022
					<ul>
						<li>Multiple dictionaries introduced on separate tabs.</li>
						<li>The case-sensitivity is implicit, that is, cases such as <i>nhs &gt; NHS</i> are pointed out automatically.</li>
						<li>The admin-site user interface is moved to <i>Content &gt; Tone Of Voice</i>. It appears on its own page.</li>
						<li>
							The <i>Prevent Submission</i> option introduced. The user-site warning box shows expressions
							which prevent the submission of the form and the document can only be pushed forward after the expression
							is either removed or corrected in the text-box.
						</li>
					</ul>
				</p>
				<p>
					<h3>Version 3.3</h3>
					24/12/2021
					<ul>
						<li>Multiple-word expressions supported.</li>
						<li>Introducing an option to make the <i>Avoid</i> expression case-sensitive.</li>
						<li>Adding an expression again makes it updated.</li>
					</ul>
				</p>
				<p>
					<h3>Version 3.2</h3>
					19/11/2021
					<ul>
						<li>A new markup for the recommended alternatives on the user form-filling page.</li>
					</ul>
				</p>
				<p>
					<h3>Version 3.1</h3>
					19/08/2021
					<ul>
						<li>The <i>Learn More</i> link can be configured on the Admin Configuration page.</li>
						<li>Setting its URL blank makes the link disappear completely.</li>
					</ul>
				</p>
				<p>
					<h3>Version 3.0</h3>
					13/07/2021
					<ul>
						<li>The initial version working with the <i>Storefront 9</i> deployments.</li>
					</ul>
				</p>
        
				<br/>

			</topic-text>
			
		</topic>


	</content>
</documentation>