Content Profiles Reference Guide

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 section and talk about each field.

Note

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.

	Content Profile name.
	Content Profile shortcut menu.
	Default system profile. You can't make any changes to this Content Profile, but you can copy or download it.

Note

Acrolinx selects the Content Profile with the criteria that best match your content. If two Content Profiles have exactly the same criteria, Acrolinx will give priority to your Content Profile over a default system profile.

For example, you create a copy of a default system profile and adjust the settings but not the criteria. Acrolinx will then choose your copy over the default system profile.

General

Name	Give your Content Profile a descriptive name. You might include the content type (for example, HTML) or the integration (for example, PowerPoint).
Description	Additional information that might be important for this Content Profile.
Check all content confidentially	Prevent any text or statistics from being written to the Acrolinx Analytics database. For more information about this feature, see the article Protect Confidential Content.

Criteria

Tell Acrolinx when to apply this Content Profile to your content.

Source Reference	Field type: File Path or Regular Expression The location of the file or files that the Content Profile applies to. You might use this property when there's no other data available to identify the file type. A file path or a path pattern entered as a regular expression. Example To apply the Content Profile to all DITA files in the "user-guides" directory, you would enter the property as follows: ./user-guides/..dita If you had multiple directories such as "user-guides" and "faqs," you would separate them with the OR operator "`\|`" like this: ./user-guides/..dita\|./faqs/..dita
Type	Choose your content type from the dropdown.
Public ID	Field type: String or Regular Expression The public ID of an XML file type. Example To assign settings to DITA concepts, you would enter the public ID as follows: -//OASIS//DTD DITA Concept//EN<
System ID	Field type: String or Regular Expression The system ID of an XML document type. Example To assign settings to DITA concepts, you would enter the system ID as follows: concept.dtd
Schema	Field type: String or Regular Expression The name of an XML document schema. Example To assign settings to XML files that use the schema "notes," you would enter the schema name as follows: notes.xsd
Root Element	Field type: String or Regular Expression 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. Example To assign settings to XML files that begin with the element `<product>`, you might enter the root element as follows: product The root element for HTML documents is always `html`.

Advanced

Integration

Field type: String or Regular Expression

The signature that an Acrolinx Integration sends when it authenticates with an Acrolinx Platform.

You might use this identifier for customized Acrolinx Integrations such as CMS integrations that don't send an integration short name.

Note

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.

Example

To assign settings to an Acrolinx Integration that uses the signature "xmF0YZzgQ233lY2tlcg," you would enter the integration as follows:

xmF0YZzgQ233lY2tlcg

Language

Field type: String or Regular Expression

The language of the check as indicated by the Acrolinx Integration.

You can use this property to change the extraction settings based on the language of the content.

Example

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.

To target the German segments in a TMX file, you would enter the language as follows:

de

Target

Field type: String or Regular Expression

You can use this criteria if you want a Content Profile to apply to a specific Target. Simply enter the name of a Target.

Note

If you don't have Targets yet, you can enter the name of a Writing Guide or Checking Profile. If your Writing Guide and a Checking Profile have the same name, Acrolinx will select the Checking Profile.

Extraction

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.

Note

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 Acrolinx processes the text.

This property prevents false issues caused by excluded elements.

Advanced

Remove Extra Whitespace

Note

This option is only present for XML Content Profiles.

Replace sequences of whitespace with a single whitespace character.

This is useful if your XML editor sends content to Acrolinx in a pretty-printed format.

If you want to set up a new XML Content Profile, you should generally select this option.

Allowed External DTDs

Field type: Regular Expression

Allow external DTDs.

You need this setting if your Content Profile applies to files that reference external DTDs.

Example

If your Content Profile applies to DocBook articles, and those articles reference the DTD "docbookx.dtd," you need to allow that DTD. Otherwise, Acrolinx will ignore it.

To allow all DTDs in the "DITA" directory, you would enter the property as follows:

.*/dita/.*.dtd

If you had multiple directories such as "DITA" and "doc book," you would separate them with the OR operator " | " like this:

.*/dita/.*.dtd|.*/doc book/.*.dtd

Entity Conversion Map

Field type: String

Tell Acrolinx how you've defined your own entities in your DTDs.

Acrolinx replaces the entity with the value. So, for the above example, Acrolinx replaces all instances of &copyright with "©."

You can enter Unicode characters two ways:

Use the escape notation like \uxxxx, where xxxx is the hexadecimal Unicode codepoint. For example, you could write copyright=\u00a9, since U+00A9 is the Unicode codepoint for ©.

Extraction Settings

Element Name	Name of the element without any syntax. Example If your element is `<comment>`, enter the following as the Element Name: comment You can also match an element and its attributes. Use the following format: elementName attribute=value Example If you have the following element: `<paragraph internal="true" title="Title of this paragraph"> </paragraph>`, your Element Name could be: paragraph internal=true Tip Use wildcards to match multiple elements or attribute values at once. For example, the following Element Name matches all elements that include the attribute `internal="true"`: Example * internal=true
Filter Mode	include - Always check this content regardless of whether it's nested inside an excluded element. exclude - Never check this content. empty - Never 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 a grammar issue. But 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 kept and Acrolinx will let it be. inherited - Use the Filter Mode of the parent element.
Break Level	sentence - 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. token - You might define elements as token breaks if you have words that aren't separated by a space. This setting defines the elements that should cause a token break. Adding a token break is basically adding a boundary between words. none - Acrolinx doesn't add any break at all. defaultBreak - Use the Default Break Level defined above.
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.
Parenthetic	Treat the element as a 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.

Context

Much of guidance is context-dependent. Map your elements to the contexts in your guidance.

	Select a context from the list or click + to add a new context.
	Enter the name of the context. You can also change the name of a context.
	The mapping field expects an XPath. List the elements that you want to map to your context. Click + to add a new mapping.

Issue Location

The issue location helps your users to find the issue that they're looking for in the Sidebar, configure the issue location.

For example, here's how it looks in the Sidebar when the issue is in a list or a table:

	Select an issue location from the list or click + to add a new issue location.
	Issue location ID.
	`XPath` Define the location with XPath.
	The localization is what appears in the Sidebar to show the name of the location of the issue.

Document Information

This section lists any custom fields that you've configured to read data from your content. You can then use XPaths to define the precise locations of each data point.

Note

This feature only works for structured formats such as XML, HTML, or Markdown. For more information about this feature, visit Configure Automatic Data Mapping.

Custom Field	The name of the custom document-level field that's configured to read data from your content.
Location	An XPath to the precise element that contains the data to receive.

How can we help?

Search

Note

Note

General

Criteria

Advanced

Note

Note

Extraction

Note

Advanced

Note

Extraction Settings

Tip

Context

Issue Location

Document Information

Note