Terminology Check in Notepad++

1. Install the PythonScript Plugin:
   • Open Notepad++.
   • Go to Plugins > Plugins Admin.
   • Search for PythonScript and install it.
   • Restart Notepad++.
2. Make sure the following file exists on your local machine: C:\Source\helpcenter.theobald-software.github.io\docs\terminology.json. If the file does not exist, pull the main branch of the helpcenter repository.
3. Open the following file with admin rights: C:\Program Files\Notepad++\plugins\PythonScript\scripts\startup.py.
4. Paste the following code into the startup.py file.

   import json
   import re
   from Npp import *
    
   # Load forbidden terms and their alternatives from the JSON file
   with open(r'C:\Source\helpcenter.theobald-software.github.io\docs\terminology.json', 'r') as f:
       forbidden_terms = json.load(f)
    
   # Create a regex pattern for forbidden terms
   forbidden_pattern = re.compile(r'\b(' + '|'.join(re.escape(term) for term in forbidden_terms.keys()) + r')\b', re.IGNORECASE)
    
   # Function to highlight forbidden terms
   def highlight_forbidden_terms():
       # Setting up indicator style and color
       editor.indicSetStyle(0, INDICATORSTYLE.FULLBOX)  # Fullbox style for highlighting
       editor.indicSetFore(0, (255, 0, 0))  # Red color for forbidden terms
    
       text = editor.getText()
    
       # Search for forbidden terms in the text
       for match in forbidden_pattern.finditer(text):
           start_pos = match.start()
           end_pos = match.end()
           editor.setIndicatorCurrent(0)
           editor.indicatorFillRange(start_pos, end_pos - start_pos)  # Highlight the forbidden term
    
   # Function to suggest alternatives if a forbidden term is selected
   def suggest_alternatives_on_selection():
       # Get the start and end positions of the selection
       selection_start = editor.getSelectionStart()
       selection_end = editor.getSelectionEnd()
    
       # Ensure the selection is non-empty
       if selection_start == selection_end:
           return
    
       # Get the selected word
       selected_word = editor.getTextRange(selection_start, selection_end).lower()
    
       # Check if the selected word is a forbidden term
       if selected_word in forbidden_terms:
           # Get the list of alternatives
           alternatives = forbidden_terms[selected_word]
    
           # Replace spaces in multi-word alternatives with underscores temporarily
           alternatives_with_underscores = [alt.replace(' ', '_') for alt in alternatives]
    
           # Show a dropdown with alternatives, using a space as the separator
           editor.autoCShow(0, ' '.join(alternatives_with_underscores))
    
   # Function to handle when a user selects an alternative from the dropdown
   def on_autocomplete_selection(args):
       # Get the start and end positions of the current selection
       selection_start = editor.getSelectionStart()
       selection_end = editor.getSelectionEnd()
    
       # Get the selected alternative from the dropdown
       selected_alternative = args['text']
    
       # Replace underscores with spaces in the selected alternative
       selected_alternative = selected_alternative.replace('_', ' ')
    
       # Replace the forbidden term with the selected alternative
       if selection_start != selection_end:
           # Ensure replacement by covering the exact range of the selected text
           editor.setTargetStart(selection_start)
           editor.setTargetEnd(selection_end)
           editor.replaceTarget(selected_alternative)
    
           # Clear the auto-completion list after replacement
           editor.autoCCancel()
    
   # Event handler for text modification
   def on_text_modified(args):
       # Highlight forbidden terms whenever the text is modified
       highlight_forbidden_terms()
    
   # Set up event listener for text modification
   editor.callback(on_text_modified, [SCINTILLANOTIFICATION.MODIFIED])
    
   # Event handler for selection changes
   def on_selection_changed(args):
       suggest_alternatives_on_selection()
    
   # Set up event listener for selection changes to trigger suggestions
   editor.callback(on_selection_changed, [SCINTILLANOTIFICATION.UPDATEUI])
    
   # Initial highlighting and setup
   highlight_forbidden_terms()

5. Save the file and open Notepad++.
6. Navigate to Plugin > Python Script > Configuration….
7. In the section Scripts, select Machine Scripts. The startup.py file should be listed in the file tree menu.
8. Select ATSTARTUP as the initialization method.
   
9. Click OK and restart Notepad++.

The script now runs in the background and checks the current document against the terminology.json file for unpermitted terms.