Notice
Acrolinx supports many standard input types. It also comes with a default mapping file of input types for common file extensions. If Acrolinx doesn't recognize your content's input file type, you may need to Configure Acrolinx to Recognize Your File Type
Acrolinx supports the following input types:
|
Input type |
File type / Extension |
|---|---|
|
Text |
*.txt |
|
HTML |
*.html, *.htm, *.xhtm, *.xhtml |
|
XML and DITA |
*.xml. *.dita |
|
DITA Map |
*.ditamap |
|
CommonMark |
*.md |
|
GitHub Markdown |
*.md |
|
JSON |
*.json |
|
Properties |
*.properties |
|
Java Code Comments - Standard |
*.java Acrolinx only checks code comments in Java files. |
|
Java Code Comments - Javadoc Style |
*.java Acrolinx only checks code comments in Java files. |
|
C++ Code Comments - Standard |
*.cpp, *.h |
|
Microsoft Word documents |
*.docx, *.docm |
|
Microsoft PowerPoint documents |
*.pptx |
|
Microsoft Excel documents |
*.xlsx |
|
|
|
|
YAML |
*.yaml |
|
Figma |
*.fig Only supported for checking within Figma. |
|
Visio |
*.vsdx |
No problem! Depending on your format, you can preprocess your content so Acrolinx can read it.
For example, reStructuredText is a file format for textual data. The Python programming language community uses it primarily for technical documentation.
Acrolinx can’t read reStructuredText (ReSt) (*.rst) files directly.
Solution: You can preprocess the ReSt formats and send the content to Acrolinx as HTML.
Acrolinx reads some formats directly, like HTML, XML, TEXT.
At the moment, we'd recommend using the Command Line Interface or the API directly. You could preprocess the RST files by converting them to a file type like XML.
Product and development teams use Acrolinx in their continuous integration processes. Developers run the Command Line Interface manually. They can also automate Acrolinx checking as a build job. Acrolinx analyzes the content during the build and returns links to Scorecards for each document. Content contributors get a notification, open the links to Scorecards, and use the feedback to correct their content.