Acronym Extractor Overview

Utilize Innoslate's Acronym Extractor to quickly gather and organize all document acronyms in a separate reference document.

Acronym Extractor

By utilizing the Acronym Extractor feature in Innoslate, users have the ability to effortlessly extract all acronyms from a document and compile them into a separate document complete with their full names. Let's walk through the process of using this convenient feature.

1. Select the ‘Acronym Extractor’ option located in the 'More' button on the toolbar of the document.

2. The Acronym Extrator window will appear, allowing users to choose the 'Extraction Options' and the 'Confidence Level' under the 'Setup' tab. The 'Extraction Options' determine which attributes the extractor will utilize to extract acronyms from the document's entities. Attributes the Acronym Extractor can extract from include All, Name and Number, Number and Description, Name, Number, Description.

In the 'Extractor Setup' step, the second option focuses on the confidence level of the Acronym Extractor. The confidence level chosen here will be displayed in the Validate step. However, do note that the Acronym Extractor performs results for all confidence levels.

acronym extractor confidence levels

A 95% Confidence level means that the acronym is found multiple times in the document with a possible detected definition.
A 65% Confidence level means that an acronym is found once with a possible detected definition.
A 40% Confidence level means that an acronym was found but there was not a definition detected with it.

2. After selecting ‘Next,’ the ‘Acronym Extractor’ window will move on to the 'Extract' step and show the number of acronyms discovered.

3. The extracted results can be found under the 'Validate' tab, as shown in the image below. Users have the option to expand or collapse the confidence levels and review the entity from which the acronym originated within the document (indicated by the red squares in the image) . This includes the entity's id, attribute field, and location.

The name field, indicated by the red arrow below, will display the detected name. Users have the ability to edit this field. After validating the results and making any necessary modifications, select the acronyms desired to include in the acronyms document, as indicated by the red circle, and click 'Next' to proceed with the final steps.

4. In the ‘Generate’ tab there are options to apply to the selected acronyms from step 3:

Under ‘Acronym Document’ users can select which document to add the acronyms to. Options include adding acronyms to that specific document’s acronym document (will create new if not already existing) or to the overall project’s Acronym Document (will create new if not already existing).
Under ‘Traceability’, users can select to create traceability from the acronyms to the current document to the acronym document. This creates a 'related to' relationship from the Acronyms entity in the Acronyms Document to the entity in the original document containing the acronym.
Under ‘Hyperlinks Creation’ users can select to create hyperlinks from the Acronyms entity in the Acronyms Document to the entity in the original document containing the acronym.

Step4 Acronym Extractor Pop Up

5. Upon selecting the 'Create' button, Innoslate users will be redirected to their new Acronyms Document (the Artifact entity will be defaulted to be named XYZ's Acronym Document), where all the extracted acronyms will appear in a new document.

acronym document sample

If desired, feel free to take it out of Paper Mode.

When users access the new Acronym document and choose individual acronym entities, they will find that the Acronyms are displayed as Statement entity with the label 'Acronym'. If traceability was selected, a 'related to' relationship is established between the Acronym Statement entity and the original entity from which the acronym originated. Below is an Acronym's Entity View exemplifying this: