User Guide Cancel

Scripting

Search
InDesign

InDesign

Open app
  1. InDesign User Guide
  2. Get to know InDesign
    1. Introduction to InDesign
      1. What's New in InDesign
      2. System requirements
      3. Common questions
      4. Use Creative Cloud libraries
    2. Workspace
      1. Workspace basics
      2. Contextual task bar
      3. Customize your workspace in InDesign
      4. Toolbox
      5. Set preferences
      6. Properties panel
      7. Touch workspace
      8. Default keyboard shortcuts
      9. Undo edits and manage History panel
      10. Document recovery and undo
    3. Generative AI (Not available in mainland China)
      1. Text to Image
      2. Generative Expand
      3. Generate Effect in InDesign (Beta)
      4. Generative AI FAQ
  3. Create and layout documents
    1. Documents and pages
      1. Create documents
      2. Work with parent pages
      3. Work with document pages
      4. Set page size, margins, and bleed
      5. Work with files and templates
      6. Convert PDFs to InDesign files in InDesign (Beta)
      7. Create book files
      8. Add basic page numbering
      9. Number pages, chapters, and sections
      10. Convert QuarkXPress and PageMaker documents
      11. Share content
      12. Understand a basic managed-file workflow
      13. Save documents
    2. Grids
      1. Grids
      2. Format grids
    3. Layout aids
      1. Rulers
      2. Align and distribute objects using rulers
      3. Measure objects using the Measure tool
  4. Add content
    1. Text
      1. Add text to frames
      2. Threading text
      3. South-East Asian Scripts
      4. Arabic and Hebrew features in InDesign
      5. Create type on a path
      6. Bullets and numbering
      7. Insert MathML to create math expressions
      8. Glyphs and special characters
      9. Text composition
      10. Text variables
      11. Generate QR codes
      12. Edit text
      13. Align text
      14. Wrap text around objects
      15. Anchored objects
      16. Linked content
      17. Format paragraphs
      18. Format characters
    2. Typography
      1. Using fonts in InDesign
      2. Kerning and tracking
      3. Scale and skew type
      4. Apply color effects to type
    3. Format text
      1. Format text
      2. Auto Style text
      3. Work with Style Packs
      4. Tabs and indents
    4. Review text
      1. Track and review changes
      2. Add editorial notes in InDesign
      3. Import PDF comments
    5. Spell check and language dictionaries
      1. Check spelling, autocorrect, and dynamic spelling
      2. Create, add, and manage dictionaries and words
      3. Change dictionary preferences
      4. Duden dictionary
    6. Add references
      1. Create a table of contents
      2. Footnotes
      3. Create an index
      4. Endnotes
      5. Captions
    7. Styles
      1. Paragraph and character styles
      2. Map, export, and manage styles
      3. Object styles
      4. Drop caps and nested styles
      5. Work with styles
      6. Leading
    8. Tables
      1. Format tables
      2. Create tables
      3. Table and Cell styles
      4. Select and edit tables
      5. Table strokes and fills
    9. Interactivity
      1. Hyperlinks
      2. Dynamic PDF documents
      3. Bookmarks
      4. Buttons
      5. Forms
      6. Animation
      7. Cross-references
      8. Structure PDFs
      9. Page transitions
      10. Movies and sounds
    10. Graphics
      1. Understand paths and shapes
      2. Draw with the Pencil tool
      3. Draw with the Pen tool
      4. Apply line (stroke) settings 
      5. Compound paths and shapes
      6. Edit paths
      7. Clipping paths
      8. Change corner appearance
      9. Frames and objects
      10. Align and distribute objects
      11. Linked and embedded graphics
      12. Integrate AEM assets
    11. Color and transparency
      1. Apply color
      2. Use colors from imported graphics
      3. Work with swatches
      4. Mix inks
      5. Tints
      6. Understand spot and process colors
      7. Blend colors
      8. Gradients
      9. Flatten transparent artwork
      10. Add transparency effects
  5. Find and replace
    1. Find and replace text
    2. Find and replace fonts
    3. Find and replace glyphs
    4. Find and replace using GREP expressions and queries
    5. Find and replace objects
    6. Find and replace colors
    7. Search options to find and replace
  6. Share
    1. Save and access cloud documents
    2. Organize, manage, and share cloud documents
    3. View and manage versions in cloud documents
    4. Common questions about InDesign cloud documents
    5. InCopy on the web (Beta)
    6. Share and collaborate        
    7. Share for Review
    8. Review a shared InDesign document
    9. Manage feedback
    10. Invite to edit
  7. Export, import, and publish
    1. Place, export, and publish
      1. Publish online
      2. Publish online dashboard
      3. Copy, insert graphics
      4. Export to Adobe Express
      5. Export content for EPUB
      6. Adobe PDF options
      7. Export to HTML5
      8. Export content to HTML (Legacy)
      9. Export to Adobe PDF
      10. Export to JPEG format
      11. Import SVG files
      12. DPS and AEM Mobile overview
      13. Supported File Formats
      14. Export and import User Settings
    2. Printing
      1. Print booklets
      2. Printer's marks and bleeds
      3. Print documents
      4. Inks, separation, and screen frequency
      5. Overprinting
      6. Create PostScript and EPS files
      7. Preflight files before handoff
      8. Print thumbnails and oversized documents
      9. Prepare PDFs for service providers
      10. Prepare to print separations
  8. Extend InDesign
    1. Automation
      1. Data merge
      2. Plug-ins
      3. Capture extension in InDesign
      4. Scripting
  9. Troubleshooting
    1. Fixed issues
    2. Known issues
    3. Crash on launch
    4. Preference folder read-only issue
    5. Troubleshoot file issues
    6. Unable to export InDesign file to PDF
    7. InDesign document recovery

Learn about how to automate common tasks using the Scripts panel and the Script Label panel in InDesign.

Sample Scripts

Community Scripts

Scripting in InDesign

Scripting is a great tool for performing a variety of tasks. A script can be as simple as an automated common task or as complex as an entire new feature. You can create your own scripts, and you can run scripts that other people have created. For more information on scripting, see Scripting Guide, scripting requirements, and other developer resources. 

The Scripting Guide contains an introduction to scripting and tutorials. You can also find a number of useful scripts that you can run, such as a script that draws guides around the selected object. Some of these scripts appear by default in the Scripts panel.

UXP Scripting 

Scripting in InDesign is now powered with the Unified Extensibility Platform (UXP) so that you can use modern JavaScript (ES5 and most of the ES6 features) to automate tasks. Find out more information about UXP Scripting.

Scripts panel and Script Label panel overview

InDesign includes two panels for scripting: the Scripts panel and the Script Label panel.

The Scripts panel is where you run scripts without leaving InDesign. The Scripts panel displays the scripts that are located in the Scripts folders in the InDesign application folder and in your Preferences folders.

Select Windows > Utilities > Scripts to open the Scripts Panel. If you create or receive a script, you can place it in the Scripts Panel folder, so it shows up in the Scripts panel.

macOS

Users/[username]/Library/Preferences/Adobe InDesign/[version]/[language]/Scripts/Scripts Panel

Windows XP

Documents and Settings\[username]\Application Data\Adobe\InDesign\[version]\[language]\Scripts\Scripts Panel

Windows Vista and Windows 7

Users\[username]\AppData\Roaming\Adobe\InDesign\[version]\[language]\Scripts\Scripts Panel
Note:

A quick way to locate the Scripts Panel folder is to right-click (Windows) or Control-click (macOS) a script in the Scripts panel and choose Reveal In Explorer (Windows) or Reveal In Finder (macOS).

The Script Label panel lets you specify a label for a page item, such as text frame or shape. Specifying labels for page items is especially useful for writing scripts in which you need to identify an object. Select Windows > Utilities > Script label to open the Script Label Panel.

For detailed information on adding, running, and editing scripts, see the Scripting Guide.

Sample scripts

You can double-click a script in the Scripts panel or run scripts using Quick Apply.

AddGuides

Adds guides around the selected object or objects.

AddPoints

Adds points to the paths of the selected object or objects.

Add QR Code

QR code can either be placed on the placegun or directly as a page item.

AdjustPageItems

Moves the content of even/odd pages by specified amounts; attempts to get objects back into the correct position after a master page margin change and/or page insertion.

AlignToPage

Aligns objects to specified positions on a page.

AnimationEncyclopedia

Automatically creates buttons with different animation properties.

BreakFrame

Removes a selected text frame and its contents from a story.

CornerEffects

Redraws the path of the selected item or items using a variety of corner effects. Corner effects can be applied to selected points on the path.

CreateCharacterStyles

Defines a complete character style based on the selected text.

CropMarks

Adds crop and/or registration marks around the selected object or objects.

ExportAllStories

Exports all stories in a document to a series of text files.

FindChangeByList

Performs a series of common text find/change operations by reading a tab-delimited text file.

ImageCatalog

Places all graphics in a specified folder in a “contact sheet” layout.

MakeGrid

Creates a grid by subdividing or duplicating the selected object or objects.

Neon

Applies a “blend” effect to the selected object or objects.

PathEffects

Changes the position of path points on the selected object or objects to add a creative effect.

PlaceMultipagePDF

Places all pages of a PDF.

SelectObjects

Selects objects on the active spread by their object type.

SortParagraphs

Sorts the paragraphs in the selection alphabetically.

SplitStory

Splits the text frames in the selected story into separate, unlinked text frames.

TabUtilities

Applies tab stops and indents to the selected text.

See Automation for more information on installing and using these sample scripts.

Community-contributed scripts

InDesign also provides more scripts that are created by the InDesign community. 

  • Unicode Injector by Kris Coppieters - Use keyboard shortcuts to easily insert one or more Unicode characters into InDesign text. For more information, see Instructions. 
  • Insert Typographer Quote by Stefan Rakete - Use keyboard shortcuts to add defined typographic quotes before and after the selected text. For more information, see Instructions. 
  • Layer Cloner by Paolo Agostinetto - This script allows you to copy one layer and its elements from one document to another. For more information, see Instructions. 
  • Get x-Height by Roland Dreger - Determine the x-height of a text passage. For more information, see Instructions.
  • Snap Margins to Text Frame by Ariel Walden - A script to modify the document's margins throughout to match the selected text frame. For more information, see Instructions.
  • Break Text Thread by Ariel Walden - An InDesign script that makes breaking the thread between text frames easy. For more information, see Instructions.
  • InCopy Note Alert by Kris Coppieters - A startup script for Adobe® InDesign® and Adobe InCopy® which alerts to the presence of notes. For more information, see Instructions.
  • Copy Paste Coordinates by Kris Coppieters - Script to copy-paste coordinates onto page items. For more information, see Instructions.
  • Chain Grep by Gregor Fellenz - Chain InDesign GREP Queries to new Scripts. For more information, see Instructions.
  • Clear Overrides by Gregor Fellenz - Clear style overrides from InDesign Text, Tables or Objects. For more information, see Instructions.
  • Invert Selection by Luis Felipe Corullón - Script to invert the selection in InDesign document. For more information, see Instructions.
  • Layer Cloner by Paolo Agostinetto - This script allows you to copy a layer and its elements from one document to another. For more information, see Instructions. 
  • End Notes to End of Book Notes by Peter Kahrel - Convert end-of-document endnotes to end-of-book endnotes. For more information, see Instructions. 
  • Renumbering Endnote References by Peter Kahrel - Script creates endnotes whose references do not update automatically when you add or remove endnotes. For more information, see Instructions. 
  • Size Thing to Page by Olav Kvern - Resizes the current selection such as an image to the size of the page. For more information, see Instructions. 
  • Size Page to Thing by Olav Kvern - Resizes the page to the size of the current selection such as an image. For more information, see Instructions.

Adobe maintains a repository of open source community scripts on GitHub. For more information about the InDesign Community Script repository, see the ReadMe file. This ReadMe file includes details about contributing a script and links to the scripters. 

More like this

Talk to us

We would love to hear from you. Share your thoughts with the Adobe InDesign Community. 

 Adobe

Get help faster and easier

New user?

Quick links

View all your plans Manage your plans
View quick links
Hide quick links

Legal Notices    |    Online Privacy Policy