Streamlining Your Google Docs: Automatically Removing the “Table of Contents” Section with Google Apps Script

by

Managing lengthy documents can be a daunting task, especially when sections like the Table of Contents (ToC) become cluttered or outdated. Whether you’re refining a report, preparing a manuscript, or updating a collaborative project, having the ability to automate the removal of specific sections can save you valuable time and effort. In this blog post, we’ll delve into a practical solution using Google Apps Script to automatically remove the “Table of Contents” section from your Google Docs.

๐Ÿ› ๏ธ Understanding the Problem

Imagine you have a Google Document that includes a Heading 2 titled “Table of Contents”, followed by various sub-sections and content. Over time, you might need to remove this section to declutter your document or update its structure. Manually searching and deleting these sections can be time-consuming, especially for lengthy documents. This is where automation comes into play.

๐Ÿš€ Introducing the removeTableOfContentsSection Function

Google Apps Script provides a powerful platform to automate tasks within Google Workspace applications, including Google Docs. The removeTableOfContentsSection function is designed to:

  1. Identify the Heading 2 titled “Table of Contents”.
  2. Remove the “Table of Contents” heading itself.
  3. Delete all content following this heading up to the next heading (of any level).

This ensures that both the “Table of Contents” heading and its associated content are entirely removed from your document, streamlining your workflow.

๐Ÿ“„ The Code

Here’s the complete Google Apps Script code for the removeTableOfContentsSection function:

function removeTableOfContentsSection() {
  // Access the active Google Document
  var doc = DocumentApp.getActiveDocument();
  var body = doc.getBody();
  var totalElements = body.getNumChildren();
  
  var startIndex = -1;
  var endIndex = totalElements; // Default to end of document
  
  // Iterate through all elements to find the 'Table of Contents' heading
  for (var i = 0; i < totalElements; i++) {
    var element = body.getChild(i);
    
    // Check if the element is a paragraph
    if (element.getType() == DocumentApp.ElementType.PARAGRAPH) {
      var paragraph = element.asParagraph();
      var heading = paragraph.getHeading();
      var text = paragraph.getText().trim();
      
      // Check for Heading 2 with exact text 'Table of Contents'
      if (heading == DocumentApp.ParagraphHeading.HEADING2 && text === 'Table of Contents') {
        startIndex = i;
        
        // Find the index of the next heading after 'Table of Contents'
        for (var j = i + 1; j < totalElements; j++) {
          var nextElement = body.getChild(j);
          
          if (nextElement.getType() == DocumentApp.ElementType.PARAGRAPH) {
            var nextParagraph = nextElement.asParagraph();
            var nextHeading = nextParagraph.getHeading();
            
            // If the next paragraph is a heading (any level), set endIndex and stop searching
            if (nextHeading != DocumentApp.ParagraphHeading.NORMAL) {
              endIndex = j;
              break;
            }
          }
        }
        
        // Once 'Table of Contents' is found and endIndex is determined, exit the loop
        break;
      }
    }
  }
  
  // If 'Table of Contents' was found, remove the section
  if (startIndex != -1) {
    // Remove elements from startIndex to endIndex - 1
    for (var i = endIndex - 1; i >= startIndex; i--) {
      body.removeChild(body.getChild(i));
    }
    
    // Optional: Inform the user that the section was removed
    DocumentApp.getUi().alert("The 'Table of Contents' section has been removed from the document.");
  } else {
    // Inform the user if 'Table of Contents' was not found
    DocumentApp.getUi().alert("No Heading 2 with text 'Table of Contents' was found in the document.");
  }
}

๐Ÿงฉ Breaking Down the Function

Let’s dissect the function to understand how it works step by step.

1. Accessing the Active Document

var doc = DocumentApp.getActiveDocument();
var body = doc.getBody();
var totalElements = body.getNumChildren();
  • DocumentApp.getActiveDocument(): Retrieves the currently active Google Document.
  • getBody(): Accesses the main body of the document where the content resides.
  • getNumChildren(): Determines the total number of elements (paragraphs, tables, images, etc.) within the document body.

2. Initializing Indices

var startIndex = -1;
var endIndex = totalElements; // Default to end of document
  • startIndex: Will hold the position of the “Table of Contents” heading.
  • endIndex: Determines where the removal should stop, defaulting to the end of the document if no subsequent heading is found.

3. Locating the “Table of Contents” Heading

for (var i = 0; i < totalElements; i++) {
  var element = body.getChild(i);
  
  // Check if the element is a paragraph
  if (element.getType() == DocumentApp.ElementType.PARAGRAPH) {
    var paragraph = element.asParagraph();
    var heading = paragraph.getHeading();
    var text = paragraph.getText().trim();
    
    // Check for Heading 2 with exact text 'Table of Contents'
    if (heading == DocumentApp.ParagraphHeading.HEADING2 && text === 'Table of Contents') {
      startIndex = i;
      
      // Find the index of the next heading after 'Table of Contents'
      for (var j = i + 1; j < totalElements; j++) {
        var nextElement = body.getChild(j);
        
        if (nextElement.getType() == DocumentApp.ElementType.PARAGRAPH) {
          var nextParagraph = nextElement.asParagraph();
          var nextHeading = nextParagraph.getHeading();
          
          // If the next paragraph is a heading (any level), set endIndex and stop searching
          if (nextHeading != DocumentApp.ParagraphHeading.NORMAL) {
            endIndex = j;
            break;
          }
        }
      }
      
      // Once 'Table of Contents' is found and endIndex is determined, exit the loop
      break;
    }
  }
}
  • Loop Through Elements: Iterates over each element in the document body to locate the target heading.
  • Identify Paragraphs: Checks if the current element is a paragraph.
  • Check Heading Type and Text:
    • getHeading(): Determines the heading level of the paragraph.
    • Text Match: Ensures the paragraph text exactly matches “Table of Contents”.
  • Find the Next Heading: After locating the “Table of Contents” heading, the inner loop searches for the next heading (of any level) to determine where the removal should stop.

4. Removing the Target Section

if (startIndex != -1) {
  // Remove elements from startIndex to endIndex - 1
  for (var i = endIndex - 1; i >= startIndex; i--) {
    body.removeChild(body.getChild(i));
  }
  
  // Optional: Inform the user that the section was removed
  DocumentApp.getUi().alert("The 'Table of Contents' section has been removed from the document.");
} else {
  // Inform the user if 'Table of Contents' was not found
  DocumentApp.getUi().alert("No Heading 2 with text 'Table of Contents' was found in the document.");
}
  • Check if Found: If startIndex is updated (i.e., the “Table of Contents” heading was found), proceed to remove the section.
  • Reverse Removal: Iterates backward from endIndex - 1 to startIndex to delete elements without affecting the loop’s integrity.
  • User Notification: Alerts the user upon successful removal or if the target heading wasn’t found.

๐Ÿ“‹ Step-by-Step Implementation Guide

Follow these steps to implement and utilize the removeTableOfContentsSection function in your Google Docs.

1. Open Your Google Document

Navigate to the Google Document from which you want to remove the “Table of Contents” section.

2. Access Google Apps Script

  • Click on Extensions in the top menu.
  • Select Apps Script from the dropdown. This action will open the Apps Script editor in a new tab.

3. Create a New Script

  • If prompted, create a new project.
  • In the script editor, delete any existing code and paste the removeTableOfContentsSection function provided above.

4. Save the Script

  • Click on the Save icon (๐Ÿ’พ) or press Ctrl + S (Cmd + S on Mac).
  • You can name the project, e.g., RemoveTableOfContentsSection.

5. Run the Script

  • Click on the Run button (โ–ถ๏ธ) to execute the removeTableOfContentsSection function.
  • The first time you run the script, you’ll be prompted to authorize it:
    • Click Review Permissions.
    • Choose your Google account.
    • Click Allow to grant the necessary permissions.

6. Verify the Changes

Return to your Google Document. The script should have removed the “Table of Contents” section, including the heading and all subsequent content up to the next heading.

๐Ÿ” Example Scenario

Before Running the Script:

1. Introduction
   - Welcome to the document.

2. Table of Contents
   - Item 1
   - Item 2
   - Item 3

3. Chapter 1
   - Content of chapter 1.

After Running the Script:

1. Introduction
   - Welcome to the document.

3. Chapter 1
   - Content of chapter 1.

In this example, the section starting with the Heading 2 titled “Table of Contents” and its subsequent content (Item 1, Item 2, Item 3) have been removed. The script stopped removing content once it encountered the next heading ('Chapter 1').

๐Ÿ“ Customizing the Script

The removeTableOfContentsSection function is versatile and can be customized to fit various scenarios. Here are some common modifications you might consider:

1. Case-Insensitive Matching

If your “Table of Contents” heading might have different casing (e.g., “table of contents”, “TABLE OF CONTENTS”), you can modify the script to perform a case-insensitive comparison.

Modified Condition:

if (heading == DocumentApp.ParagraphHeading.HEADING2 && text.toLowerCase() === 'table of contents') {

Full Modified Script:

function removeTableOfContentsSectionCaseInsensitive() {
  var doc = DocumentApp.getActiveDocument();
  var body = doc.getBody();
  var totalElements = body.getNumChildren();
  
  var startIndex = -1;
  var endIndex = totalElements;
  
  for (var i = 0; i < totalElements; i++) {
    var element = body.getChild(i);
    
    if (element.getType() == DocumentApp.ElementType.PARAGRAPH) {
      var paragraph = element.asParagraph();
      var heading = paragraph.getHeading();
      var text = paragraph.getText().trim();
      
      // Case-insensitive comparison
      if (heading == DocumentApp.ParagraphHeading.HEADING2 && text.toLowerCase() === 'table of contents') {
        startIndex = i;
        
        for (var j = i + 1; j < totalElements; j++) {
          var nextElement = body.getChild(j);
          
          if (nextElement.getType() == DocumentApp.ElementType.PARAGRAPH) {
            var nextParagraph = nextElement.asParagraph();
            var nextHeading = nextParagraph.getHeading();
            
            if (nextHeading != DocumentApp.ParagraphHeading.NORMAL) {
              endIndex = j;
              break;
            }
          }
        }
        
        break;
      }
    }
  }
  
  if (startIndex != -1) {
    for (var i = endIndex - 1; i >= startIndex; i--) {
      body.removeChild(body.getChild(i));
    }
    
    DocumentApp.getUi().alert("The 'Table of Contents' section has been removed from the document.");
  } else {
    DocumentApp.getUi().alert("No Heading 2 with text 'Table of Contents' was found in the document.");
  }
}

2. Removing Multiple “Table of Contents” Sections

If your document contains multiple “Table of Contents” sections and you wish to remove all of them, you can modify the script to iterate through the document repeatedly until all instances are removed.

Modified Script to Remove All Instances:

function removeAllTableOfContentsSections() {
  var doc = DocumentApp.getActiveDocument();
  var body = doc.getBody();
  
  var removedCount = 0;
  
  while (true) {
    var totalElements = body.getNumChildren();
    var startIndex = -1;
    var endIndex = totalElements;
    
    // Iterate to find the first 'Table of Contents' heading
    for (var i = 0; i < totalElements; i++) {
      var element = body.getChild(i);
      
      if (element.getType() == DocumentApp.ElementType.PARAGRAPH) {
        var paragraph = element.asParagraph();
        var heading = paragraph.getHeading();
        var text = paragraph.getText().trim();
        
        if (heading == DocumentApp.ParagraphHeading.HEADING2 && text === 'Table of Contents') {
          startIndex = i;
          
          for (var j = i + 1; j < totalElements; j++) {
            var nextElement = body.getChild(j);
            
            if (nextElement.getType() == DocumentApp.ElementType.PARAGRAPH) {
              var nextParagraph = nextElement.asParagraph();
              var nextHeading = nextParagraph.getHeading();
              
              if (nextHeading != DocumentApp.ParagraphHeading.NORMAL) {
                endIndex = j;
                break;
              }
            }
          }
          
          break;
        }
      }
    }
    
    // If no 'Table of Contents' found, exit the loop
    if (startIndex == -1) {
      break;
    }
    
    // Remove elements from startIndex to endIndex - 1
    for (var i = endIndex - 1; i >= startIndex; i--) {
      body.removeChild(body.getChild(i));
    }
    
    removedCount++;
  }
  
  if (removedCount > 0) {
    DocumentApp.getUi().alert("Removed " + removedCount + " 'Table of Contents' section(s) from the document.");
  } else {
    DocumentApp.getUi().alert("No Heading 2 with text 'Table of Contents' was found in the document.");
  }
}

3. Targeting Different Heading Levels

If your “Table of Contents” uses a different heading level (e.g., Heading 1 or Heading 3), adjust the HEADING2 constant accordingly.

Example for Heading 1:

javascriptCopy codeif (heading == DocumentApp.ParagraphHeading.HEADING1 && text === 'Table of Contents') {

โš ๏ธ Important Considerations

While the removeTableOfContentsSection function is a powerful tool, it’s essential to understand its limitations and ensure it’s used correctly.

1. Exact Match Requirement

  • Case Sensitivity: The script searches for a Heading 2 with the exact text “Table of Contents”. Variations in casing (e.g., “table of contents”, “TABLE OF CONTENTS”) will not be recognized unless you modify the script for case-insensitive matching.
  • Exact Text: Ensure there are no extra spaces or hidden characters in the heading. The text must precisely match “Table of Contents”.

2. Document Structure Assumptions

  • The script assumes that the “Table of Contents” section is correctly formatted with Heading 2 styles.
  • The content to be removed should follow immediately after the heading and continue until the next heading of any level.

3. Backup Your Document

Before running scripts that modify your document, it’s a best practice to create a backup. This ensures you can restore the original document if something doesn’t work as expected.

4. Script Permissions

Google Apps Script requires permissions to modify your documents. Ensure you review and grant the necessary permissions when prompted.

๐ŸŒŸ Conclusion

Automating document management tasks can significantly enhance your productivity and ensure consistency across your work. The removeTableOfContentsSection function provides a straightforward solution to remove the “Table of Contents” section from Google Docs, freeing you from the tedium of manual editing. By customizing and expanding upon this script, you can tailor it to suit a variety of document management needs.

Whether you’re a student managing research papers, a professional handling reports, or anyone in between, leveraging Google Apps Script can streamline your workflow and empower you to handle documents more efficiently.