Scribendi AI Documentation
Scribendi AI Documentation
Contents...................................................................................................................................................................... 1
RELEASE 2.5................................................................................................................................................................. 8
Dialect Suggestions Fixed.........................................................................................................................................8
Release 2.4.2.0.............................................................................................................................................................8
Editor rule manager fixed........................................................................................................................................ 8
Large file processing.................................................................................................................................................8
Oxford comma button modified..............................................................................................................................8
Custom comments functionality fixed.....................................................................................................................8
Error messaging.......................................................................................................................................................8
Backend rules updated............................................................................................................................................ 8
Release 2.4.1.0.............................................................................................................................................................9
Anonymize feature fixed..........................................................................................................................................9
UI improvements..................................................................................................................................................... 9
“Formal” and “Concise” buttons..............................................................................................................................9
“Find and Replace” and “FIeld Code Comment” have been removed.....................................................................9
“general settings” and “consistency check settings” are now under “settings”.......................................................9
Updated Rules..........................................................................................................................................................9
Release 2.4.0.0...........................................................................................................................................................10
Scribendi AI UX/UI Improvements.........................................................................................................................10
Import Comments fixed.........................................................................................................................................10
Scribendi frelance editors are required to accept the terms of use when installing scribendi Ai...........................10
Release 2.3.3.1...........................................................................................................................................................11
New – Order id attached to Report issue functionality..........................................................................................11
Error Fixed..............................................................................................................................................................11
Disabled low number rule......................................................................................................................................11
‘multispace’ local rule has been disabled...............................................................................................................11
Scribendi End user license agreement is updated..................................................................................................11
Comment manager Fixed.......................................................................................................................................11
Login fails if special characters are included in the password................................................................................11
Free trial based on the first user login...................................................................................................................11
Free trial.................................................................................................................................................................11
NEW! Scribendi AI..................................................................................................................................................11
NEW! toolbar installation and registration process updated.................................................................................12
Bug fixed – user Did not get NLP access.................................................................................................................12
Consistency Check fails on a large document........................................................................................................12
Release 2.3.2.6...........................................................................................................................................................13
Legacy Comment Manager....................................................................................................................................13
Grouped Tabs Icons...............................................................................................................................................14
NLP API Request.....................................................................................................................................................14
Release 2.3.1.8...........................................................................................................................................................14
Critical Issue Fixed..................................................................................................................................................14
Release 2.3.1.7...........................................................................................................................................................14
New QA Score Card Feature...................................................................................................................................14
New Rule Settings Dialog – Coming Soon!.............................................................................................................15
New Style Guide Setting Introduced – Coming Soon!............................................................................................15
Fixed Handful of Dialect Suggestions.....................................................................................................................16
Significant Breakthroughs Made To Omit Oxford Setting.......................................................................................16
Streamlined Installer Updates................................................................................................................................16
Significant Breakthroughs Made To Overall Accelerator Performance..................................................................16
Release 2.3.1.6...........................................................................................................................................................17
Alpha Beta Model Testing Button..........................................................................................................................17
Accelerator No Longer Removing the Symbol ®....................................................................................................17
Superlative & Comparative NLP Rules....................................................................................................................17
“Ignore All Further Instances of” Button................................................................................................................17
Warning When Selecting Dialect Other than the Order Dialect.............................................................................18
Random QA Sample Button....................................................................................................................................18
Undo Suggestion Feature.......................................................................................................................................18
Release 2.3.1.5...........................................................................................................................................................19
Scribendi Accelerator Does Not Process Footnotes Warning.................................................................................19
"A" versus "An" Rule..............................................................................................................................................19
View Button on Accelerator Suggestion Card Now Attempting to Center Referenced Text...................................20
Ellipsis Character no Longer Masked with Replacement Character.......................................................................20
Single Progress Bar for Accelerator Progress Dialog..............................................................................................21
Small Navigation Arrows Added to the Consistency Checker Detail Screen...........................................................21
500 Word Limit Warning for Free Trial Users.........................................................................................................22
New Private Mode—Coming Soon!.......................................................................................................................22
Minor Reorganization of Toolbar...........................................................................................................................23
Release 2.3.1.4...........................................................................................................................................................23
Formal "it's" Rule................................................................................................................................................... 23
All Caps Warning When Applying Changes............................................................................................................24
Consistency Checker Standardize Single Jumps to Next Instance..........................................................................24
Consistency Checker Categories with Zero Hits Shown Faded and Below Other Categories.................................24
Post Installation "Start Microsoft Word" Option....................................................................................................25
Consistency Checker Back Button Click No Longer Removes Previously Viewed Inconsistency.............................25
Free Trial Invalid Account Message Removed........................................................................................................26
Consistency Checker Option Hit Counter...............................................................................................................26
Changed "Dialect" to "No Dialect" with Grey When No Dialect is Specified For Accelerator.................................26
Improved Handling of VSTO Dependency in Toolbar Installer...............................................................................26
Release 2.3.1.3...........................................................................................................................................................27
"Machine Learning" Changed to "AI Recommendation"........................................................................................27
Card Color and the Accelerator Button Menu Color Matched...............................................................................27
Consistency Checker Category Explanations Simplified.........................................................................................27
All Rules Labeled....................................................................................................................................................28
Years not Flagged in the Numbers Category of the Consistency Checker..............................................................28
Toggle for Consistency Checker Categories Added Settings...................................................................................28
Oxford Comma Setting Made Visible on Accelerator Menu...................................................................................29
Natural Language Processing Model Options Cleaned Up.....................................................................................29
Release 2.3.1.2...........................................................................................................................................................30
Release 2.3.1.1...........................................................................................................................................................30
New EM Code & Employee Name Requirement for Scribendi Accelerator Use.....................................................30
New Consistency Checker Rule Categories............................................................................................................31
Em Dash Consistency.........................................................................................................................................31
Figure/Fig. Consistency......................................................................................................................................31
Oxford Comma Consistency...............................................................................................................................31
Quote Style Consistency.....................................................................................................................................32
Slash Spacing Consistency..................................................................................................................................32
Word Variant Consistency..................................................................................................................................32
New Rule-Based Model – G1.................................................................................................................................32
Capitalization of First Word in Sentence............................................................................................................32
Duplicate Word Typos........................................................................................................................................32
Em Dash and Hyphen Spacing Issues..................................................................................................................32
Numeric Issues...................................................................................................................................................32
Equations, Forumulas, and Mathematical Expression Formatting Issues...........................................................32
Multiple Spacing Issues......................................................................................................................................33
Hyphens with Numbers Issues...........................................................................................................................33
Numeric Range Issues........................................................................................................................................33
Spacing Issues related to Unit Measurements...................................................................................................33
"Et cetera" Abbreviation Comma Issues.............................................................................................................33
Latin Abbreviation Parenthesis issues................................................................................................................33
Semicolon/Comma Separated List Issues...........................................................................................................33
Title and Header Casing Issues...........................................................................................................................33
Release 2.3.1.0...........................................................................................................................................................33
Special Characters in Editor Comments Now Supported.......................................................................................33
Fixed Consistency Checker Issues..........................................................................................................................33
Renaming Previous Models....................................................................................................................................34
Minor Optimization made to Accelerator Processing Speed..................................................................................34
Minor Enhancement to Scribendi Toolbar Installer...............................................................................................34
Release 2.3.0.9...........................................................................................................................................................34
New & Improved Model.........................................................................................................................................34
Quotations, Apostrophes, and EN/EM Dashes.......................................................................................................34
First Progress Bar Delay Fixed................................................................................................................................35
Non-Accelerator Bookmark or Grey Ghost Bracket Preservation..........................................................................35
Editor Rule Model..................................................................................................................................................35
Editor Rule Abstraction With Regular Expressions.................................................................................................35
Batch Ignore With Search...................................................................................................................................... 36
Release 2.3.0.8...........................................................................................................................................................36
New – Three Consecutive Letter Rule....................................................................................................................36
Update – UI Milestone Checkpoint........................................................................................................................36
New – Custom Toolbar Comments........................................................................................................................36
New – Editor Rules for the Accelerator..................................................................................................................37
New Toolbar Installation Wizard................................................................................................................................38
Release 2.3.0.7...........................................................................................................................................................39
New Standard For "Internet" Suggestion...............................................................................................................39
Accelerator Post Processing State Update.............................................................................................................39
Help Menu Enhancements.....................................................................................................................................40
Accelerator Progress Dialog Style Update..............................................................................................................40
Consistency Checker Style Update.........................................................................................................................40
Card Flash Color Update........................................................................................................................................ 43
Release 2.3.0.6...........................................................................................................................................................44
Updating Theme Setting No Longer Requires Word Restart..................................................................................44
New—Suggestion Search.......................................................................................................................................44
Improved Handling of Special Characters..............................................................................................................44
New NLP Rules for Two Common Abbreviations...................................................................................................45
New—Minimal Edit Approach................................................................................................................................45
Release 2.3.0.5...........................................................................................................................................................45
NEW SETTING—THEME.........................................................................................................................................45
Modern Blue......................................................................................................................................................46
Modern Artic......................................................................................................................................................46
Modern Coral Sea.............................................................................................................................................. 47
Modern Dark Stormy Night................................................................................................................................48
Modern Dark Lazer.............................................................................................................................................49
Modern Dark Fluid.............................................................................................................................................50
Fixed Bug With Prepare Document Process...........................................................................................................51
Fixed Ambiguous Dialect Suggestions....................................................................................................................52
Relocation of Accelerator-Related Settings............................................................................................................52
Improved Design of the Clean COpy Button...........................................................................................................52
Release 2.3.0.4...........................................................................................................................................................52
Fixed Side Pane Bug...............................................................................................................................................52
Fixed Consistency Checker Bug..............................................................................................................................52
Fixed Dialect Suggestions.......................................................................................................................................53
Improved Handling of Suggestion Cards Referencing Deleted text........................................................................53
Fixed Missed Suggestions.......................................................................................................................................53
New Theme Setting With UI Enhacements............................................................................................................53
Suggestion Categorization by Color and Labels in the Modern Theme..................................................................54
Release 2.3.0.3...........................................................................................................................................................55
NEW - In-text "Ghost" Bracket Indicators for Suggestions.....................................................................................55
NEW- Added "Ignore Suggestion" Button to Pane UI.............................................................................................55
FIXED - Dialect Suggestion Issues...........................................................................................................................55
FIXED - SCRIBENDICODE Suggestion Removed.......................................................................................................56
FIXED - Accelerator Pane UI Resizing Issue.............................................................................................................56
FIXED - Task Bar Blocking Issue..............................................................................................................................56
FIXED - Double Click Issue When Scrolling through Accelerator Pane UI...............................................................56
FIXED - Duplicate Error Window Showing on Suggestions Created after Stopping the Accelerator.......................56
FIXED - Suggestions Related to Roman Numerals & Abbreviations........................................................................56
FIXED - Frequent Errors Occurring Behind the Scenes...........................................................................................56
Improved Performance..........................................................................................................................................56
Release 2.3.0.2...........................................................................................................................................................57
NEW – Accelerator UI Setting.................................................................................................................................57
Performance Optimizations...................................................................................................................................57
Blue Box UI.............................................................................................................................................................57
Pane UI...................................................................................................................................................................57
Pane With Overlay UI.............................................................................................................................................58
Custom Overlay Underline Color........................................................................................................................58
Warning About Changing Accelerator UI During Editing........................................................................................59
Release 2.3.0.1...........................................................................................................................................................59
FIXED – Several Bug Fixes.......................................................................................................................................59
NEW – Features..................................................................................................................................................... 59
NEW – Rules...........................................................................................................................................................59
NEW – Settings.......................................................................................................................................................60
Release 2.3.0.0...........................................................................................................................................................60
FIXED – Several Bug Fixes.......................................................................................................................................60
NEW – Settings.......................................................................................................................................................60
Release 2.2.3.5...........................................................................................................................................................60
FIXED – Several Bug Fixes.......................................................................................................................................60
Release 2.2.3.4...........................................................................................................................................................60
NEW – Centralized Logging....................................................................................................................................60
NEW – Scribendi Consistency Checker...................................................................................................................60
Scribendi Consistency Checker - How to Guide..................................................................................................61
Release 2.2.3.2...........................................................................................................................................................65
FIXED – Several Bug Fixes.......................................................................................................................................65
Release 2.2.3.1...........................................................................................................................................................65
NEW – Settings.......................................................................................................................................................65
NEW – Automatic Document Backups...................................................................................................................66
FIXED – Right-Click Insert Comment Bug................................................................................................................67
NEW – General Feedback Button...........................................................................................................................67
FIXED – Connectivity Issues....................................................................................................................................67
NEW – Run Accelerator Button..............................................................................................................................67
NEW – Ignore Suggestions Button..........................................................................................................................69
NEW – Anonymize Button......................................................................................................................................69
NEW – Remove & Undo Field Code Comment Buttons..........................................................................................70
Known Issues......................................................................................................................................................... 70
Recommendations.................................................................................................................................................71
Option A.............................................................................................................................................................71
Option B.............................................................................................................................................................71
Conclusion..............................................................................................................................................................71
RELEASE 2.5
This release resolves an issue with the Grammar Check module incorrectly suggesting dialect changes for words.
User can now rectify this by selecting the correct dialect parameter, ensuring accurate and seamless language
refinement.
RELEASE 2.4.2.0
The Editor Rule Manger functionality was not working as expected, as some rules that had been created by editors
were not being applied when the Grammar Check was run. This issue has now been fixed.
With particularly large files, the Grammar Check was taking a considerable amount of time to process the
document. To avoid any unexpected delays, the message will appear before the file processing is initiated to notify
editors if the potential wait time is long. This message will appear only when the document length exceeds 20,000
words.
The Oxford Comma (i.e., Serial Comma) button on the Grammar Check has been updated; it now provides clearer
descriptions for the options.
The Custom Comments were not working as expected when special characters were included in the comments.
This issue has now been fixed.
ERROR MESSAGING
When the Grammar Check was run on a document, the software would occasionally freeze at 25%. New messaging
was added to notify users that, in order to proceed with the document, they would need to run the Grammar
Check separately on smaller sections of the document.
RELEASE 2.4.1.0
The “Anonymize” feature was not working as intended, and thus not removing the names of editors. This has now
been fixed.
UI IMPROVEMENTS
The user interface of the software was not displayed properly: the Grammar Check buttons were being cropped
and their size changed. This was due to a scaling issue, which has now been fixed.
The user interface for the “Grammar Check” has now been updated. The “Formal” and “Concise” buttons are no
longer available as customizable features in the software. The Dialect and Oxford comma settings, however,
remain unchanged.
“FIND AND REPLACE” AND “FIELD CODE COMMENT” HAVE BEEN REMOVED
The “Find and Replace” and the “Field code comment” buttons have been removed from the Scribendi AI Add-in
for MS Word.
“GENERAL SETTINGS” AND “CONSISTENCY CHECK SETTINGS” ARE NOW UNDER “SETTINGS”
The "General Settings" and "Consistency Check Settings" are now under one button: "Settings." Clicking this button
will allow users to customize the software according to their needs.
UPDATED RULES
A rule was added for the American dialect: only the verb "analyse" will be targeted and not "analyses" (which is
not only a verb form of “analyse” but a plural noun form of “analysis” that is necessary in American English).
RELEASE 2.4.0.0
When importing Legacy Comments, the comments were not visible in the “Insert Comment” function. This has
now been fixed.
SCRIBENDI FRELANCE EDITORS ARE REQUIRED TO ACCEPT THE TERMS OF USE WHEN INSTALLING
SCRIBENDI AI
When installing the Scribendi AI Add-in for MS Word, everyone is now required to click “I agree” to accept the
Terms of Use.
RELEASE 2.3.3.1
ERROR FIXED
An error previously occurred when the “Quote” setting was changed in the General Settings of the
Accelerator, stopping the Accelerator from running. This error has been fixed.
FREE TRIAL
Bug fixed – For users with an active subscription, the Toolbar would previously show that the free trial
had expired. This issue has now been fixed.
NEW! SCRIBENDI AI
A new Scribendi AI tab has been added to the Scribendi Client Account. We have introduced the new
“Scribendi AI” name, which has been substituted for the previous “Scribendi Toolbar.” This tab is now
independent from the Scribendi API Access. Under this tab, the user can see the subscription expiry date
and can renew the subscription.
Only activate the Toolbar free trial on the API login endpoint if the app key is for the
Toolbar
Added a client ID validation to the showToolbarAccess() endpoint of the API
Fixed the webhook to work with the new installation process while remaining backwards
compatible
Fixed possible 500 Errors in the webhook
Added an IT alert to the webhook if it fails to find the client
BUG FIXED – USER DID NOT GET NLP ACCESS
Previously, users were sometimes unable to login to the Toolbar because the NLP access was not
enabled. This issue was caused by a missing `AppData\Local\Scribendi\Toolbar` directory. A fallback
code has been added to the 2.3.3.1 branch to mitigate this issue.
A warning message has been added when the Consistency Checker is run.
The document will now be saved before the user proceeds with the Consistency Checker.
The Consistency Checker has been moved to the Beta Feature group.
WildcardOrder loading has been added prior to the Toolbar access verification. (WildcardOrder
loading is essential for the elasticAPM setup.)
The Logger will check if the logging agent has been initialized before running.
A condition check has been added before the ribbon invalidation
RELEASE 2.3.2.6
A new module has been added that allows a user to migrate the older format of custom comments, via .txt files,
into the new Custom Comment Manager.
Upon selecting the Legacy Comments tab, a file selection prompt will appear; navigate to the .txt file used with the
previous Custom Comments feature.
A window will appear displaying a list of the comments that are compatible with the import process. The user can
then check or uncheck the comments to indicate which comments they would like to import.
When the “Import” button is clicked, the import process will begin. Upon completion, the status will be displayed
to the user in the same window.
Note: The user will need to restart MS Word for the new comments to appear in the Insert Comment pane and the
“right-click” context menu.
On smaller displays, grouped tabs will now show a relative icon instead of a blank placeholder.
The request sent to the language processor by the Accelerator module has been adjusted to accommodate local
rule services. As a result, the users should see an improvement in processing times.
RELEASE 2.3.1.8
A critical issue involving the internal workings of the Scribendi Toolbar has been fixed. No additional features have
been added.
RELEASE 2.3.1.7
In order to speed up the QA process, a new QA Score Card feature has been added to assist editors in performing
QAs. The score card is calculated based on the QA comments in the document. Here is a preview of the score card:
There are additional categories not shown. When editors do a QA, it is highly recommend that they try out this
new feature to assist in calculating the score.
A new Rule Settings dialog has been added in this version to allow editors to override the behavior of the rule-
based models used by the Accelerator. Editors can view this new dialog by clicking the Rule Settings button on the
toolbar:
Editors can activate or deactivate the specific rules used by the various rule-based models. If there is a rule that is
an issue, editors can simply deactivate the rule by deselecting the active checkbox on the right hand side of the
dialog. The “Rule Example” column captures the essence of the rule. The “Description” and “Tags” columns provide
more information regarding the types of rules and what causes them to be used by the Accelerator. If editors also
provide feedback regarding the rules, that will be a great step toward advancing the power of the tool. The only
disclaimer about this new feature is that it is currently only in preview and is coming soon.
A new setting has been added that allows editors to configure which style guide the Accelerator should use when
generating suggestions.
This style guide setting is also coming soon and is currently only in preview. In the future, this setting will tune the
Accelerator suggestions to conform to the chosen style guide.
A handful of dialect suggestion issues have been fixed in this version. The fixes were based on feedback from the
Scribendi Toolbar forum. Using the new Rule Settings dialog, please review the other dialect-based rules to
determine if any need adjustment.
The Omit Oxford setting issue was identified through the Scribendi Toolbar forum. However, a new breakthrough
has been made to improve the accuracy of this setting. As a result, fewer recommendations should be seen that
suggest adding the Oxford comma when the setting is set to “Omit Oxford”.
The Scribendi Toolbar Installation Wizard has been improved by streamlining the step that requests the type of
user that is installing the toolbar.
Scribendi editors will first enter a name and email. Then they will click the checkbox that asks them if they are a
Scribendi editor. This will show the EM code input prepopulated with the “EM” text to assist with entering the EM
code. After entering the EM code, the “Next” button should be clicked.
Prospective clients will simply enter a name and email and then click the “Next” button.
Previously, the Accelerator would sporadically suggest cutting off the end of sentences. The development team
determined the root cause of the issue and has delivered a fix in this new version.
Previously, the Accelerator would sometimes suggest a recommendation that involved no change (i.e., the target
and the replacement text were identical). This issue has also been fixed in the new version.
RELEASE 2.3.1.6
A new button has been added to enable quick toggling between our alpha and beta Natural Language Processing
models. The alpha model will be our cutting-edge model leveraging the latest technology. The beta model will be
our more stable, tested model. Please feel free to try both and see which one you prefer. If you do not use the NLP
Model setting in the settings dialog to choose either the alpha or beta model, then the alpha beta model testing
button will show the Greek letter gamma (ɣ).
Previously, the Accelerator removed the registered trademark symbol ®. The Accelerator will no longer remove
this symbol in suggested changes.
The Accelerator now checks for issues regarding superlative and comparative forms. Please see the image below
for examples.
The “ignore all further instances of” button, Ignore*, will ignore all suggestions identical to the current suggestion
being ignored. Clicking this button would remove the two suggestions in the following example because they are
identical in terms of error and correction.
WARNING WHEN SELECTING DIALECT OTHER THAN THE ORDER DIALECT
Orders sometimes have a specified dialect. If the editor chooses a dialect different from the one specified in the
order when using the Accelerator, they will see an alert warning that the dialect set for the Accelerator does not
match that on the order.
A new toolbar button has been to assist editors with the QA process. When pressed, the button will randomly
select a QA sample. After a QA sample is selected, QA editors can format the selection as they like (highlight, paint
with background color, etc.).
An undo button has been added to the Accelerator menu bar, as shown below:
Please try to use this feature after accidentally accepting or ignoring a suggestion. A word of caution: Clicking undo
leverages Word’s native undo functionality, so try to use it only right after accepting or ignoring a suggestion to
avoid applying an unwanted undo to a document.
RELEASE 2.3.1.5
Previously, when editors attempted to run the Scribendi Accelerator on a footnote, nothing would happen. Now, a
warning message will be shown indicating to the editor that the Accelerator does not work on footnotes.
The Scribendi Accelerator will now attempt to offer suggestions to correct issues in the document regarding the
usage of "a" versus "an". Here's an example of this new rule in action:
VIEW BUTTON ON ACCELERATOR SUGGESTION CARD NOW ATTEMPTING TO CENTER REFERENCED
TEXT
When clicking the View button on a suggestion card, Word will attempt to scroll to the text the card is referencing
and vertically center the text on the screen if the referenced text is not currently in view. This feature will help
editors see the entire sentence that a suggestion relates to without the need to scroll up or down to see more of
the sentence.
Now that the Accelerator's performance has improved, the four progress bars have now been reduced to one
single progress bar, as shown:
Small navigation arrows have been added to the Scribendi Consistency Checker detail screen. These small arrows
will allow the editor to navigate more easily between the various inconsistencies found by the Scribendi
Consistency Checker. The arrows appear in the upper right portion of the detail screen, as shown below:
500 WORD LIMIT WARNING FOR FREE TRIAL USERS
For prospective clients outside Scribendi using the free trial version of the Scribendi Toolbar, the Accelerator only
processes 500 words at a time. When prospective clients have more than 500 words selected, the following
warning will now show to alert the client that, despite having more than 500 words selected, only the first 500
words will be processed:
A new button has been added to the Scribendi Toolbar, which will enable private mode:
The alert in the image above captures the essence of this new button. In the future, the Scribendi Toolbar may
have a private mode that allows users to keep their sensitive documents private.
In this version, the toolbar settings have been organized in a new command group, as shown below:
This change should make the toolbar settings easier to find. In addition, a new command group has been created
to organize our new features once they have stabilized. This new command group is shown below:
RELEASE 2.3.1.4
When the formal language setting is activated on the Accelerator menu bar, the Accelerator will recommend the
following change:
ALL CAPS WARNING WHEN APPLYING CHANGES
When caps lock is on when applying a change, a warning message will appear telling the editor to turn off caps
lock. If caps lock is left on, then the applied change will be in all capital letters.
After clicking the "Standardize Single" button in the Consistency Checker Category Detail screen, the next hit will
automatically be selected and in focus for review. This should speed up editor workflow significantly for editors
who want to review each inconsistency in detail prior to resolving it.
CONSISTENCY CHECKER CATEGORIES WITH ZERO HITS SHOWN FADED AND BELOW OTHER
CATEGORIES
In this version, consistency checker categories with zero hits will be shown faded out and below other categories.
POST INSTALLATION "START MICROSOFT WORD" OPTION
The last screen of the installation wizard will now ask if the user would like to open up Microsoft Word:
In previous versions, clicking the back button on the consistency checker category detail screen deleted the
inconsistency that was in view. Now, the back button will not delete the inconsistency.
FREE TRIAL INVALID ACCOUNT MESSAGE REMOVED
Prospective clients with a free trial account will no longer see the invalid account message after clicking the "OK"
button on the about screen.
Next to each inconsistency, there will be an indicator showing how many times the inconsistency appeared in the
document.
CHANGED "DIALECT" TO "NO DIALECT" WITH GREY WHEN NO DIALECT IS SPECIFIED FOR
ACCELERATOR
For the sake of clarity, the Accelerator dialect setting has been updated to explicitly say that "No Dialect" is chosen
when a dialect has not been specified. In addition, the button in this state has been greyed for emphasis.
If the Scribendi Toolbar Installation Wizard does not find the VSTO dependency on the end user's machine, the
user will now be able to start the installation of this dependency directly instead of having to navigate to a web
page. This should make the installation process smoother overall, and the normal installation process will resume
after the VSTO dependency has finished installing.
RELEASE 2.3.1.3
Machine learning–based suggestions will now be labeled differently. Instead of being marked as "Machine
Learning," suggestions will instead be marked as "AI Recommendation."
The color that appears on the top of each card should match the relevant button on the menu. For an example,
please see the screenshot below:
All examples have been removed from the Scribendi Consistency Checker category explanations and placed instead
in hover tooltips; they can be seen by hovering over the explanation text, as shown below:
Please note that the machine learning models may have learned a given rule, such as the Oxford comma, so it is
still possible to see an "AI Recommendation" label for such rules. In summary, if you see "AI Recommendation,"
then the change came from our machine learning models, but if you see a different label, the change came from a
rule-based model.
In previous versions of the Scribendi Consistency Checker, dates were often flagged in the numbers category.
Dates are now excluded from this category.
A new dialog has been added to configure the Scribendi Consistency Checker categories. This dialog can be found
by clicking the boxed arrow icon in the "Beta Features" group of the toolbar:
From this dialog, editors can choose which consistency categories to include in the consistency check. Please note
it may take a brief moment for the settings to save.
The Oxford comma setting is now accessible from the accelerator menu bar instead of the settings window. This
change will make it easier for editors to find the Oxford comma setting and use it appropriately.
The NLP Model options in the settings dialog will now show the following drop-down:
Each model has been named with a short code, and the ensemble models include the names of all models in the
ensemble.
RELEASE 2.3.1.2
The editors should notice no real functional differences in this release. This release is for prospective clients.
RELEASE 2.3.1.1
NEW EM CODE & EMPLOYEE NAME REQUIREMENT FOR SCRIBENDI ACCELERATOR USE
To use the Scribendi Accelerator, editors will now be required to enter their name and EM code. The Scribendi
Toolbar Installation Wizard will prompt for this required information:
Editors that leverage the auto update feature of the installer can provide an em code and name on the About
screen. Editors can click on the "About" button located on the Scribendi Toolbar in the Additional Information
group:
The Scribendi Accelerator will not run until an EM code and name are entered:
New consistency checker rule categories have been introduced in this new version. These categories are described
below.
EM DASH CONSISTENCY
This rule category finds inconsistent spacing with em dashes. CMOS recommends closed dashes (no spaces), but
open variants exist (e.g., UK English). Editors can elect a spacing standard to resolve inconsistencies.
FIGURE/FIG. CONSISTENCY
This rule category finds inconsistent expression of "figure" and its possible abbreviations (e.g., "fig." or "fig") before
figure numbers or letters, such as "Figure 1" vs. "Fig. 1" and "Figure A" vs. "Fig A.", and offers editors the
opportunity to resolve such inconsistencies by choosing a standard.
A new rule-based model has been developed: Rule-based Model – G1. This model can be invoked in isolation or in
an ensemble style. This model is dependent upon the concept of sentence splitting. As a disclaimer, the initial
version of this model used the default sentence splitter offered by Word, which is not ideal and causes some rules
to function incorrectly. We hope to use our own custom sentence splitter in future to greatly improve this model's
performance. It tries to correct a variety of mistakes, which are described below.
NUMERIC ISSUES
This rule attempts to replace certain numeric symbols with their word form. For example, the digit "2" would be
replaced with the word "two".
RELEASE 2.3.1.0
In the previous versions of the toolbar, editor comments containing special characters would break the toolbar and
make the toolbar disappear. This issue has been fixed, and now, comments should appear even if they contain the
special characters mentioned on the forum.
There are now the following natural language processing (NLP) models available for use:
Step three of the Scribendi Accelerator's processing has been sped up slightly. The optimization will be more
noticeable with longer documents.
The Scribendi Toolbar Installer now accounts for another installation issue that can happen. If you encounter any
issues with the installer, please let Toolbar Support know.
RELEASE 2.3.0.9
The machine learning team at Scribendi has created a new natural language processing model to improve the
Accelerator. This model is called "New Model" in the settings dialog. This new model should operate significantly
faster than the previous model, now called "Old Model." In addition, we hope that this new model offers better
suggestions. Editors can choose which model to use by selecting the appropriate model within the NLP Model
dropdown in the settings dialog:
The new model will be the default model. If there are any issues with the new model, then editors can always
revert to the old model.
In previous versions, the first progress bar in the accelerator progress dialog would occasionally remain empty as
the subsequent three progress bars continued progressing on. In this version, the first progress bar should now
function as expected.
Bookmarks or "Ghost Brackets" appear in Microsoft Word as grey brackets around content. In previous versions of
the toolbar, all bookmarks were deleted from the document first before being repurposed as an in-text indicators
for Accelerator suggestions. Non-Accelerator bookmarks will now be preserved due to editor demand. As a result,
editors may sometimes double-click on bookmarked or ghost bracketed content (expecting to see an Accelerator
suggestion card flash and appear in the side pane) but get an alert instead indicating that no suggestion can be
found. This will only happen for non-Accelerator bookmarks. While Accelerator and non-Accelerator bookmarks
cannot be distinguished visually at present, we hope to resolve this issue in the next version of the toolbar. Editors
can now use the Accelerator without fear that non-Accelerator bookmarks will be lost, and Accelerator bookmarks
will continue to work as they have in previous versions. So if double-clicking on a bookmark produces an alert, then
just continue to the next bookmark. Editors should also note that the ignore suggestions button will only remove
Accelerator bookmarks.
Editors can choose the option of "Editor Rule Model" for the NLP Model setting in the settings dialog. The "Editor
Rule Model" option will configure the Accelerator to only use editor rules when making suggestions.
Power users can now leverage regular expression syntax when crafting rules. Regular expressions allow editors to
create rules that are abstract and cover more cases. To create a regular expression rule, editors must use the '=>'
syntax instead of the '->' syntax. On the left-hand side of the '=>', editors should insert a target regex to use. Please
note that certain characters like quote and apostrophe are curly by default in Microsoft Word, and this can be a
common oversight when crafting a regex. On the right-hand side of the '=>', editors should insert a replacement
phrase to use. Editors can leverage grouping references in the replacement phrase by typing '$' followed by a
number. Here's an example of an editor rule that can handle many common double negative phrases:
In this example, note the use of the curly apostrophe. Also, the use of "\s" for space and "(\w+)" for an arbitrary
word. Since the arbitrary word is surrounded by parenthesis, it can be referenced in the replacement expression
with the "$1". Hence, this rule is capable of resolving all the following double negatives:
Previously, editors would have to create exact rules for each case, but with regex, one abstract rule can cover all
like cases. Editors can learn more about regular expressions at:
https://docs.microsoft.com/en-us/dotnet/standard/base-types/regular-expressions
Editors can now use the suggestion search with the ignore button to perform a batch suggestion ignore. First,
editors can perform a search to find common suggestions. Then, editors can click the ignore button which will
ignore all the suggestions found in the search. This feature will speed up editor workflow by allowing editors to
ignore multiple suggestions simultaneously. Please note that this feature takes precedence over other ignore
functionality. While there is a search term present, "ignore by selection" and "ignore all suggestion" functionality
will be temporarily disabled because it will be overridden by "ignore by search". Once the search term is cleared,
then the "ignore by selection" and "ignore all suggestions" mode will be enabled for use.
RELEASE 2.3.0.8
The Scribendi Accelerator will now attempt to correct typos regarding three consecutive letters. It is very unlikely
for an English word to have three consecutive letters. Sometimes three consecutive letters are used to create
sound effects, so prudence should still be exercised when determining whether a suggestion applies to a given
context.
In this version of the toolbar, the UI of certain screens has been updated. The update serves as a development
milestone and the UI will be further branded in subsequent versions. The idea behind these updates is to roll out a
fully branded product in subsequent releases. In addition, it is our hope that the new UI will make it feasible to one
day offer a version of the Scribendi Editor Toolbar for both the online and Mac versions of Microsoft Word.
Editors can now create custom comments for use with the Scribendi Editor Toolbar. The first step is to create a text
file where your comments will be stored. This file can be named anything you would like and stored in any folder.
Each comment must be on its own line in the text file. The comment category comes first, then the arrow delimiter
of "->", and finally the comment text that will appear in a comment bubble. Here's an example of a comment file:
Editors can then reference the comment file by navigating to the settings dialog in the toolbar. In the settings
dialog, a textbox has been added where editors can type the file path of the comment file.
Editors can then save the settings. For comments to appear in the comment gallery and right-click context menu,
Word must be restarted. After Word restarts, editors should be able to use the custom comments.
Editors can now customize the Scribendi Accelerator with custom editing rules. This feature works similarly to the
custom comment feature. The first step is to create a text file where your rules will be stored. This file can be
named anything you would like and stored in any folder. Each rule must be on its own line in the text file. The
target text comes first, then the arrow delimiter of "->", and finally the replacement text that the Accelerator will
suggest. Here's an example of a rule file:
Editors can then reference the rule file in the settings dialog of the toolbar. A textbox has been added where
editors can type the file path of the rule file.
Editors can then save the settings. Editors are encouraged to work together to create rule files that are extremely
powerful. It is highly recommended to craft rules during the editing process as this will greatly speed up your
editing speed in the future. If you find a common error, the error paired with the correction would make a great
candidate for a rule. Currently rules are very specific but, in future versions, the development team has plans to
support more abstract patterns which should elevate the power of the rules. This feature provides the editor a
steering wheel that pairs nicely with the Accelerator!
The Scribendi Editor Toolbar can now be installed via the new Scribendi Editor Toolbar Installation Wizard. This
custom installer attempts to resolve common issues that can occur during the installation of the toolbar. In
addition, the wizard may be extended in the future to provide a better installation experience. When running the
installer, the editor will see the following menu screen.
From this menu, editors can choose to install or uninstall the toolbar. When the editor clicks "install," the installer
begins to execute.
The installer attempts to first resolve potential errors that could occur during installation. Once this is complete,
the installer wizard loads.
Clicking the "Install" button will then continue the installation. If the installation is not successful, editors can
always contact the senior editor and one of the toolbar support members can assist with installation.
RELEASE 2.3.0.7
The Scribendi Accelerator will now suggest "internet" with a lowercase "i" instead of "Internet" with an uppercase
"I" when processing technical documents. This change conforms to our default style guide.
After the Scribendi Accelerator has completed processing, the first suggestion to be reviewed will be displayed.
Prior to this change, the last suggestion was displayed.
HELP MENU ENHANCEMENTS
Clicking on "help" on the menu now prompts the help document to open in Word rather than in a dialog box. This
makes the document easier to read through.
The dialog that indicates accelerator progress now shows status updates with style. The spinning 3D cube has been
replaced with a circular progress spinner and progress bars for each step. Here's a preview of the new progress
dialog:
The development team has updated the user interface for the Scribendi Consistency Checker. The consistency
checker can be launched by clicking the "Start" button:
When running the consistency checker, the following progress dialog will appear:
Once the consistency checker completes, the following menu will be presented:
This menu organizes and categorizes the inconsistencies found. Clicking on a menu option shows the details about
a given inconsistency:
CARD FLASH COLOR UPDATE
When an editor double clicks on the text within "ghost brackets," the card that corresponds to the related
bracketed text will flash briefly. Here's how the flashing card will appear:
RELEASE 2.3.0.6
The Accelerator Suggestion Side Pane will automatically change as the theme changes. Users no longer need to
close and reopen Word for the theme to take effect.
NEW—SUGGESTION SEARCH
Users can now use the new search bar to navigate the list of suggestions. The search targets the suggestion type
label, the text in the "Error" box, and the text in the "Correct" box for a given suggestion. The search uses a
"contains" methodology for searching. For example, searching for "a" will match text such as "nice day".
In future versions, the search bar will perform batch operations effectively, such as ignoring all suggestions that
target the phrase "also" and applying all suggestions with a given phrase.
Sometimes the suggestion pane does not know how to display a special character. In the past, these special
characters would often just be removed from the display, which created confusion for editors. In this version, any
special character that cannot be displayed easily in the suggestion pane will be shown as �. Here's an example of
how this will appear:
In this example, a special apostrophe character was used, hence the � character in use.
The Accelerator should now think twice before attempting to capitalize the subsequent letter after the following
abbreviations:
e.g.
i.e.
Editors noticed that, when applying a suggestion, the targeted text was first deleted and then replaced. This
strategy, though simple, was problematic for two reasons:
Now, when applying a suggestion, Minimal Edit mode will be used. This will help solve the aforementioned
problems. If you prefer the old way of applying suggestions, you can always select this approach using the
Suggestion Edit Strategy setting:
RELEASE 2.3.0.5
NEW SETTING—THEME
The toolbar has a new theme setting. The theme setting changes the style of the Accelerator Suggestion Side Pane.
Please note that when changing a theme, Word must be restarted. Here is a preview of the themes available:
MODERN BLUE
MODERN ARTIC
MODERN CORAL SEA
MODERN DARK STORMY NIGHT
MODERN DARK LAZER
MODERN DARK FLUID
FIXED BUG WITH PREPARE DOCUMENT PROCESS
If the editor prepares a document while the tracked revised copy is open, Word will now attempt to first close the
tracked revised copy, overwrite it, and then reopen the tracked revised copy. This change will not affect most
editors who follow our standard editing workflow.
In some dialects, multiple spelling variations are acceptable depending on many factors. For words that have
multiple acceptable spellings in a given dialect, the Accelerator will not try to force a specific choice when there are
multiple correct options. For example, a word may be spelled differently depending on its part of speech.
Suggestions will be made if the Accelerator thinks it has narrowed down the options to one correct option.
Editors have asked that the suggestion-related settings be made more accessible. The main Accelerator-related
settings have been moved to the Accelerator Suggestion Pane Menu Bar, as shown below:
Concise and Formal buttons turn yellow when activated and grey when inactive. The green dialect button shows
the dialect that will be used for suggestions. Clicking on the buttons will change the setting in a predictable
manner. Hovering over the buttons will show a tooltip with useful information.
The clean copy button should have a new look in this version of the toolbar:
RELEASE 2.3.0.4
There was a rare bug in the previous version of the toolbar where the Accelerator Side Pane would show
suggestions for the wrong document. It should now only show the suggestions for the document that the side
pane is attached to. The Accelerator Side Pane will be labeled with the document name to ensure that the
suggestions are relevant to the document.
The Hyphen Space category in the Scribendi Consistency Checker would sometimes confuse a forward slash '/'
character as a word break character. This bug would lead to the consistency checker offering suggestions like the
following:
Places
Place S
This suggestion was a false positive and would sometimes be created if the relevant text contained a '/'.
In the forum, editors noted that in certain situations, the dialect spelling of a word depended on the part of speech
it functioned as in a sentence. For the words pointed out recently in the forum, changes have been made to fix
these specific cases. We hope to continue to refine the dialect-based suggestions with your helpful feedback.
While using the accelerator, editors can—in theory—delete large chunks of text at any time. The deleted text was
sometimes referenced by a suggestion. The delete operation essentially makes the suggestion no longer valid. As a
result, if an editor attempts to view, apply, or ignore a suggestion that no longer references text, an alert will show
indicating this and the card will be removed.
There was a bug in the previous version of the toolbar that would sometimes cause the first suggestion of a
document to be lost. This bug has been fixed in this new version to ensure editors get every useful suggestion
possible.
A new theme setting has been introduced in this new version of the toolbar. The theme setting on the settings
dialog can be used to change the Accelerator Suggestion Pane appearance. There are currently two options:
Classic
Modern—Default
Modern: Classic:
The Modern theme has a badge in the upper right to indicate the number of suggestions yet to be reviewed.
Please note that if you change the theme setting, you must close and reopen Word for the theme to take full
effect.
If the Modern theme looks a little off, you may need to upgrade your version of Internet Explorer to version 11+ as
the Modern theme styles require this; otherwise, you will have to use the Classic style if you are unable to update.
The suggestions are now labeled and color coded based on suggestion type. There are currently five types:
Machine Learning—Blue
Dialect—Red
Concise—Green
Formal—Purple
Multiple Types—Black
These type indicators will help us improve the suggestions overall by helping the development team focus on any
specific types of suggestions that need improvement based on feedback from the editing team.
Ghost brackets are a new and improved way of interacting with suggestions directly through the text of a
document. This approach is similar to the blue box and underline overlay that was loved by our editors but without
all the drawbacks.
The text in the ghost brackets is directly editable, and the brackets will "vanish" automatically after
editing.
Double clicking on the text in the ghost bracket will automatically scroll to the relevant card in the Side
Pane and should do so without any lag.
These brackets are responsive and efficient.
No document cleanup is required for the brackets.
If you want to quickly ignore all suggestions without scrolling through each and ignoring them one by one, you can
click the Ignore Suggestions button. This button will either ignore all suggestions when no text is selected or ignore
only those suggestions that are selected.
In rare circumstances, the dialect rule did not apply in every case. For example, some dialects hold the following to
be true simultaneously:
Dependant
Independent
This version seeks to fix issues like this by limiting the scope of the dialect suggestion.
On rare occasions, some editors noticed "SCRIBENDICODE" appearing in the suggestions. The suggestions should
no longer show this in the new version.
When resizing Word, the Accelerator Pane would sometimes be resized incorrectly. This release fixes the resize
issues.
Editors with a hover over taskbar noticed difficulties when using the accelerator. The taskbar was being shown
under Word when it should always appear on top of any application. This behavior was corrected in this new
release.
When scrolling through the Accelerator Pane UI, sometimes editors would accidentally double click on the scroll
arrows, and this would cause the scrolling to reset to the previously viewed card. This behavior was corrected in
this new release.
FIXED - DUPLICATE ERROR WINDOW SHOWING ON SUGGESTIONS CREATED AFTER STOPPING THE
ACCELERATOR
When stopping the Accelerator during the decoration step, editors would sometimes encounter an error when
clicking on the last suggestion in the document. This odd error has been accounted for and handled more
elegantly.
The Accelerator offered incorrect suggestions regarding roman numerals and certain abbreviations. In this version,
changes were made to resolve some issues regarding these types of suggestions.
A handful of bugs have been fixed in this version that were frequently occurring behind the scenes. This translates
to a more responsive and stable product for our editors.
IMPROVED PERFORMANCE
The first step of the Accelerator process has been optimized to execute faster on large documents. Previously, this
step could take 30–40 seconds on documents 25–50 pages long. Now with large documents, this step should
execute significantly faster. In the testing of this optimized hardware, this 30–40 second delay has been reduced to
1–2 seconds. Stay tuned for performance updates for the remaining steps of the Accelerator process.
RELEASE 2.3.0.2
NEW – ACCELERATOR UI SETTING
Blue Box (familiar blue box from previous version that editors know and love)
o Double click the text marked by an underline to auto-scroll to the suggestion in the side pane
PERFORMANCE OPTIMIZATIONS
BLUE BOX UI
The Blue Box UI is the most familiar and perhaps most popular UI for the Accelerator. This UI was loved by editors
but has one major flaw, which is that it leaves blue box "stains" in the document. Editors must be cautious not to
return documents with blue boxes back to the client. This version brings back the familiar Ignore Suggestions
button, which can ignore all suggestions or remove selected suggestions.
Extremely Important: If the Ignore Suggestions button is NOT removing the blue boxes, then you must EXACTLY
select the blue box and then click the Ignore Suggestions button. Many editors missed this last point, which led to
an influx of emails requesting assistance with blue box removal. Here is an example of what is meant by EXACTLY
select the blue box:
Notice how only the text "have 2 cats" has been selected. Clicking the Ignore Suggestions button will then remove
only this blue box.
PANE UI
The Pane UI, which was introduced in the last version, does not suffer from this blue box flaw. The suggestions will
appear in the side pane like this:
The flaw with the Side Pane is that the suggestion marks are not indicated directly in the document, which our
astute editors noticed.
The pane with the overlay approach synthesizes the best of both the Side Pane and the Blue Box UI into one
coherent approach. This is our main UI that we are trying to perfect and is therefore the default, so please try it
and give us feedback on your experience. Here is what the side pane with Overlay UI looks like:
The blue hovering lines are back, but this time they should be more performant. Double clicking on the text
marked with the hovering underline causes the side pane to auto-scroll to the relevant suggestion. Once the
suggestion is scrolled to, the suggestion card flashes briefly to indicate that the card was found. The user can then
either accept or ignore the suggestion using the side pane.
Please avoid changing the Accelerator UI settings in the middle of an editing session because suggestions are
cleared when the Accelerator UI settings are changed. Experiment with the UIs and use the one that best suits your
editing preferences. Please note that we want to perfect the Pane with Overlay approach and will require your
feedback on this method to refine it. We want to keep our editors happy as we refine this method, and this is why
we brought back the Blue Box UI for now.
RELEASE 2.3.0.1
Fixed some dialect suggestion bugs regarding "ll" words and tightened up rules to target only certain
prefix and suffixes
Removed activation button
Fixed the issue of missed Accelerator suggestions in the text starting with leading whitespace
Revised the suggestion popup to use buttons instead of icons
Fixed connection issues with metadata endpoint
Reduced scope of Oxford comma regular expression to reduce false positives
Temporarily disabled the overlays
NEW – FEATURES
NEW – RULES
NEW – SETTINGS
RELEASE 2.3.0.0
Implemented new overlay suggestion UI. This should resolve several issues related to suggestion boxes
and speed things up for you
Toolbar loading and initialization approach changed to the "just-in-time" model. This resolves several
issues
The accelerator popup no longer appears on top of other application windows
Made suggestion popups take up less space on the screen
Consistency Checker should now work in multiple instances of Word
NEW – SETTINGS
RELEASE 2.2.3.5
RELEASE 2.2.3.4
Centralized logging has been introduced to facilitate troubleshooting bugs and other issues. This should have no
impact on the end user.
Abbreviations
Balanced Brackets
Capitalization
Date Format
Ellipsis
Formalities
Hyphens and Spacing
Names
Numbers
Quotes
Ranges
Spelling
Clicking on the button Start Consistency Checker will start the consistency checker. If a document is long, it could
take some time to run the consistency checker to completion. A progress indicator will show notifying the editor
the current progress of the consistency checker.
Once complete, the editor will see the consistency checker menu showing the number of inconsistencies found
next to each type of inconsistency, if there are inconsistencies. If no inconsistencies have been found, the menu
will not be shown.
From the menu, editors can view the inconsistencies by category. For example, the spelling category has found the
following inconsistency:
The Scribendi Consistency Checker has found that the words
Center
Centre
are inconsistently spelled words referring to the same concept. The editor can then choose one of the following
options:
Ignore or continue by clicking the Next button
View the next match in the document of the selected term by clicking the View Next Match button.
Resolve inconsistencies with the chosen option by clicking the button Standardize Selection.
Use Find & Replace to manually resolve inconsistencies
Click the Back button to escape from this detail screen and return to the menu.
Once all the inconsistencies have been processed, the following screen should appear:
The editor can rerun the consistency checker by clicking the Try Again! Button to find more inconsistencies if they
exist.
RELEASE 2.2.3.2
RELEASE 2.2.3.1
NEW – SETTINGS
Figure 1: Clean Copy Comment Rescue and NLP Model
The Scribendi development team has introduced two new settings in this release. Turning the Clean Copy
Comment Rescue setting "on" will attempt to rescue comments attached to deleted text. If this setting is on and
the Make Clean Copy button is clicked, the Scribendi Toolbar will attempt to rescue comments attached to deleted
text by accepting deletions character by character. DISCLAIMER—it is best to use this feature sparingly right now as
it can take a while to make a clean copy when this setting is on. In addition, it is strongly advised that editors avoid
commenting on deleted text and rather put a comment just before or after the deleted text so that comments are
not lost once the deletions are accepted during the creation of a clean copy. The NLP Model setting allows editors
to choose what type of natural language processing model to use when executing the accelerator. Currently,
editors can choose:
Ensemble
o Uses a combination of machine learning and rule-based approaches
Machine Learning
o Learns how to make corrections based on patterns learned through training
Rule-Based
o Uses a large list of rules to find well-defined grammatical patterns that can be easily improved
Please feel free to try out the various options and use the one that best suits your editing needs.
When using any new beta functionality, the Scribendi development team wants to ensure that if issues occur, you
are able to restore the document to the previous state. Backup copies of the document will automatically be saved
in a new folder with the prefix phrase "BACKUP_...," which will be located in the same folder the document resides
in. Please remember to delete the backup folder when you are done with a customer's document to comply with
our customer data security policies. If a beta feature gives you any issues, feel free to overwrite the damaged
document with a backup copy. Please ensure to rename the restored document with the correct file name. Backup
copy names include a timestamp, so please ensure that the timestamp is removed. The following figure shows
what this backup process will look like on your computer:
In the past, editors noticed that when using the Right-Click Insert Comment function, the comment was being
incorrectly inserted into the body of the document. This bug should be resolved in this version of the toolbar. In
addition, if this feature is used when the cursor is within a comment balloon, the text should be directly inserted
into the comment balloon.
After using the new toolbar for some time, please feel free to give the Scribendi Toolbar development team
feedback by filling out our survey. The survey can be accessed by clicking the General Feedback button in the
toolbar (coffee cup icon). We are very interested in hearing our editors' opinions of the toolbar, so please don't be
shy!
The Scribendi Toolbar is now using upgraded technology for the Report Issue button. In the past, some editors
were unable to report toolbar issues. Editors should now be able to use this button as long as they are connected
to the internet.
We have introduced a new Run Accelerator button in the toolbar. The general workflow is as follows:
Ensure that the document is a Scribendi document. The accelerator is intended to be used on Scribendi
documents only.
Select the text within the document you would like the Scribendi Accelerator to analyze.
o The selection can be a single paragraph, multiple paragraphs, or the whole document.
o The whole document is automatically analyzed if no text is selected.
o The more text that is selected, the longer it will take, so on long documents, plan accordingly.
o Try to avoid selecting more than 45 pages when running the accelerator.
o For larger documents, you can run the accelerator on 45 pages at a time.
o An error may occur if too much text is selected, and you may be prompted to select
less text.
The following dialog should then appear.
The Ignore Suggestions button has multi-level functionality. First, if no text is selected and this button is clicked, it
should remove all suggestions—unless the document that is being edited has intrinsic issues and is not compliant
with the Open XML standard. In this case, the user can manually select the entire document using CTRL + A, and
then clicking this button will attempt to ignore all suggestions in the document. If the document is long or the
selection is long, this could take a moment to complete. Editors can also select an arbitrary amount of text and
then click this button to remove suggestions in the selection only. This is especially helpful for free samples when
suggestions need to be removed from the remaining portion of the document.
The Anonymize button allows editors to choose a name to anonymize. The use of this feature results in the chosen
name being replaced with "." in the comments and in the revision tracking pane. This feature is mainly for those
users who run into difficulty with configuring Word to anonymize the author name by default. Ideally, editors
should strive to configure Word to use the "." for identification purposes, but if the editor struggles with the
configuration, they should be able to use this button to anonymize the name.
The main purpose of these new buttons is to remove the undesirable Unknown Field Code Change comments that
sometimes accumulate when references are edited or table of contents are edited. For those who are unfamiliar,
this is what the Unknown Field Code Change comments look like:
The removal of these comments can be undone by clicking the Undo button (or CTRL + Z). However, please be
cautious when using this functionality as once these comments are accepted, confirmed, and saved, the undo
button may not be able to undo the deletion of these comments.
KNOWN ISSUES
1. Please be cautious when accepting a suggestion that contains text with different formatting. For example,
if a portion of the text is bold and a portion is not, while inside the blue box, the resulting text after
accepting a suggestion could be all bold or not bold at all. This is limited only to the suggestion text and is
a rare occurrence.
RECOMMENDATIONS
In terms of the Accelerator usage, the Scribendi Toolbar development team would recommend the following
workflows, but feel free to do what works best for you:
OPTION A
1. Run the Accelerator as you go, paragraph by paragraph.
2. Accept/reject each change in the paragraph.
3. Manually edit the paragraph.
4. Run the Accelerator once again on the current paragraph as a sanity check.
5. Continue on to the next paragraph.
OPTION B
1. Run the Accelerator on the entire document—or a large portion of it—before editing the document.
2. Accept/reject each change.
3. Manually edit the document using your workflow.
4. Run the Accelerator one last time as a sanity check.
5. Accept/reject each change.
Using the proposed workflows should help you avoid most of the known issues or pitfalls and the need to use the
Ignore Suggestions button. Of course, you can customize your workflow as you see fit, but this is what the
development team suggests. You can run the accelerator before editing, after editing, or at any time in your
workflow.
CONCLUSION
This new version of the toolbar has undergone some significant changes, and we hope that you will enjoy them.
Please let us know if anything does not work as expected, especially regarding the new functionality. Please report
any issues and recommendations using the Report Issue button and the General Feedback button. We hope to
release new versions more frequently this year, so please stay tuned!