|Acrolinx Server||5.3, 5.4, 5.5, 5.6, 2018.10|
Content Profiles let you configure how Acrolinx reads your content. You'll find Content Profiles under Guidance Settings in the Dashboard. In this guide, we'll go through each tab of the Content Profiles feature in the Dashboard and talk about what the fields are.
If you’re using one of the Acrolinx Sidebar integrations, you’ll notice that the Filter and Segmentation options that are available in the Classic edition aren’t there. This is because you can now define how Acrolinx reads your content on the Acrolinx Server so that your writers don’t have to worry about it.
All the changes that you make in your Content Profile are effective immediately.
On the landing page, you'll see a list of all your Content Profiles. Here you can upload or add a new one.
|1||Content Profile name.|
|2||Content Profile shortcut menu.|
|3||Default system profile. This means that you can't make any changes to this Content Profile, but you can make a copy of it or download it.|
If you have 2 identical Content Profiles, Acrolinx uses the one further up the list.
|Name||Give your Content Profile a descriptive name. You can include the content type, for example, HTML or the integration, for example, PowerPoint.|
|Description||Include additional information that might be important or relevant about this Content Profile.|
Define how to tell Acrolinx when it should apply this Content Profile to your content.
The location of the file or files that the Content Profile applies to.A file path or a path pattern entered as a regular expression.
For example, to apply the Content Profile to all DITA files in the "user-guides" directory, you would enter the property as follows:
If you had multiple directories such as "user-guides" and "faqs", you would separate them with the OR operator "
When you use regular expressions, bear in mind that you need to use the syntax for Java-style regular expressions . If you're not sure if the expression you want to use is valid, you can easily test it with this Java Regular Expression Tester .
|Type||Choose your content type from the dropdown.|
The public ID of an XML document type.
For example, to assign settings to DITA concepts, you would enter the public ID as follows:
The system ID of an XML document type.
For example, to assign settings to DITA concepts, you would enter the system ID as follows:
The name of an XML document schema.
For example, to assign settings to XML files that use the schema "notes", you would enter the schema name as follows:
The root element of an XML or HTML document.
You might use this for simple XML documents that don't have a document type definition or schema.
For example, to assign settings to XML files that begin with the element
The root element for HTML documents is always
The signature that an Acrolinx integration sends when it authenticates with an Acrolinx Server.
You might use this identifier for customized Acrolinx integrations such as CMS integrations that don't send a plug-in short name.
Only use this matching criterion if no other matching criteria work for you.
Matching on the signature means that the Content Profile will only match when writers check from a certain editor. It can be useful if the host editor is the only way of determining the document type.
For example, to assign settings to an Acrolinx integration that uses the signature "xmF0YZzgQ233lY2tlcg", you would enter the integration as follows:
The language of the check as indicated by the Acrolinx plug-in.
You can use this property to change the extraction settings based on the language of the content.
One scenario might be that you're checking a multilingual XML format such as TMX. You would want to include the parts of the file that match the checking language.
For example, to target the German segments in a TMX file, you would enter the language as follows:
Enter the name of the Writing Guide.
You could use this criteria if you want a Content Profile to apply to a specific Writing Guide.
|Starting Element||The Starting Element set to ‘include’ works for most cases. This means that Acrolinx will read everything.|
|Default Break Level||
Define how the text should be broken up, such as sentence break or token break elements.
XML processing instructions have their break level set to none by default. You can always set this to a different value if you need to.
|Mark excluded elements||
Insert placeholders for excluded elements when processing the text.
This property prevents excluded elements causing false issues.
|Allowed External DTDs||
Define a whitelist of external DTDs.
You need this setting if your Content Profile applies to files that reference external DTDs.
For example, if your Content Profile applies to DocBook articles, and those articles reference the DTD "docbookx.dtd", you need to whitelist that DTD. Otherwise, the server will ignore it.
You can find out more about how to handle external DTDs in the article Remapping the Source Paths for External DTDs .For example, to whitelist all DTDs in the "dita" directory, you would enter the property as follows:
If you had multiple directories such as "dita" and "docbook", you would separate them with the OR operator "
|Entity Conversion Map||
Tell Acrolinx how you've defined your own entities in your DTDs.
Enter your entities in the format:
Acrolinx replaces the entity with the value. So, for the above example, Acrolinx replaces all instances of '©right;' with '©'.
You can enter Unicode characters two ways:
|1 - Element Name||
Name of the element without any syntax. For example, if your element is <comment>, then enter 'comment'.
Acrolinx matches the element to your content using the Element Name.
You can also match an element and its attributes. Use the format: elementName attribute=value
For example, <paragraph internal="true" title="Title of this paragraph"> </paragraph>
Then your Element Name could be:
|2 - Filter Mode||
Always check this content regardless of whether it's nested inside an excluded element.
Never check this content.
emptyNever check this content but include it in the grammatical structure of the sentence.
For example, you might have text that refers to user interface labels. Take the following sentence.
The options Use slithy toves and Gyre and gimble in the wabe will cause a Jabberwocky to appear."You could exclude the bold text to stop Acrolinx from checking the option names, but then Acrolinx would read the sentence like this:
The options and will cause a Jabberwocky to appear.
To Acrolinx, this sentence would look like grammar issue. However, if you were to set the bold text as "empty", Acrolinx would read the sentence like this:
The options (empty) and (empty) will cause a Jabberwocky to appear.
In this last example, the grammatical structure is retained and Acrolinx will let it be.
Use the Filter Mode of the parent element.
|3 - Break Level||
If you have elements that contain sentences that don't end with a period, define them as sentence-break elements. This means that the end of the element should always be treated as a sentence end.
Acrolinx doesn't add any break at all.
Use the Default Break Level defined above.
|4 - Attributes to Extract||
Attributes in your elements that you want Acrolinx to read.
For example, if you had a paragraph element that has the attributes title and subtitle.
<paragraph internal="true" title="Title of this paragraph" subtitle="This is the subtitle of this paragraph"> </paragraph>
If you want Acrolinx to read the title and subtitle, then add 'title' and 'subtitle' to your Attributes to Extract.
|5 - Parenthetic||
Treat the element as separate sentence, even if it's embedded in another sentence.
A typical example is a footnote that's embedded in the middle of a sentence like this:
<p>This is the <footnote>This is a second sentence.</footnote> first sentence.</p>
This situation is kind of rare, but it's good to know about it anyway. You know, just in case.
Much of Guidance is context-dependent. Map your elements to the contexts in your Guidance.
|1||Select a context from the list or click + to add a new context.|
|2||Enter the name of the context. You can also change the name of a context.|
|3||The mapping field expects an XPath. List the elements that you want to map to your context. Click + to add a new mapping.|
Configure issue location to help your users find the issue that they're looking for in the Sidebar, for example, if the issue is in a List or a Table. Here's how it looks in the Sidebar:
|1||Select an issue location from the list or click + to add a new issue location.|
|2||Issue location ID.|
Define the location with XPath.
|4||The localization is what appears in the Sidebar that shows the name of the location of the issue.|