Docs

/**
 * Add a logo image into the header of all Tabs and Subtabs of every Docs file in a given folder.
 * Author: Mr Shane.
 * Version: 2024-11-11
 */
function addLogoToAllTabs() {
  const folderId = "1yYtvYZ7G4S1yqG947yavqKoJhQE_JMl8"; // Configure the Folder ID where the Docs files are stored.
  const imageId = "1nPWkU8vW-oylyMaLqxQRxVmxj4u53eLo"; // Configure the File ID of the PNG logo image.
  const folder = DriveApp.getFolderById(folderId); // Get the folder.
  const imageFile = DriveApp.getFileById(imageId); // Get the logo image.
  const imageBlob = imageFile.getBlob().setContentType("image/png"); // Ensure the image is a PNG.
  const files = folder.getFilesByType(MimeType.GOOGLE_DOCS); // Get all Google Docs files in the folder.
  while (files.hasNext()) {
    const file = files.next();
    const doc = DocumentApp.openById(file.getId());
    let tabs = doc.getTabs(); // Get all first-level tabs in the document.
    const stack = []; // Initialize an array to stack tabs and subtabs during iteration.
    for (let i = 0; i < tabs.length; i++) { // Add all tabs to the stack.
      stack.push(tabs[i]);
    }
    while (stack.length > 0) {
      const currentTab = stack.pop(); // Get the last Tab from the stack.
      const documentTab = currentTab.asDocumentTab(); // Retrieve the Tab contents as a DocumentTab.
      let header = documentTab.getHeader(); // Get or create the header for this tab.
      if (!header) { // IF there is no header...
        header = documentTab.addHeader(); // Create a header.
      }
      header.clear(); // Clear existing content in the header.
      const table = header.appendTable([["", ""]]); // Insert a table in the header with two columns.
      table.setBorderWidth(0); // Remove table borders for a cleaner look.
      const rightCell = table.getCell(0, 1); // Set the right cell for inserting the image.
      rightCell.insertImage(0, imageBlob); // Insert the image into the right cell.
      const childTabs = currentTab.getChildTabs(); // Get child tabs (subtabs) and push them to the stack.
      for (let j = 0; j < childTabs.length; j++) {
        stack.push(childTabs[j]);
      }
    }
    doc.saveAndClose(); // Save and close the document after modifications.
  }
}

/**
 * Bionic Reading WITHOUT an add-on
 * Author: Mr Shane
 * Version: 2025-05-13
 *
 * If you want an add-on, then try this one:
 * @see https://chromewebstore.google.com/detail/bionic-reading/kdfkejelgkdjgfoolngegkhkiecmlflj
 *
 * Documentation:
 * @see https://developers.google.com/apps-script/reference/document/element-type
 * @see https://developers.google.com/apps-script/reference/document/paragraph-heading
 */
function onOpen() {
  const ui = DocumentApp.getUi(); // Get the UI of the active document.
  ui.createMenu("⚠️Admin Menu⚠️") // Create a custom menu.
    .addItem(`Bionic "Normal text" outside tables`, "bionicNormalTextOutsideTable") // Add menu item.
    .addItem(`Bionic All "Normal text"`, "bionicNonHeaders") // Add menu item.
    .addItem(`Bionic EVERY Word`, "bionicEveryWord") // Add menu item.
    .addItem(`Bold all text outside tables`, "boldTextOutsideTable") // Add menu item.
    .addItem(`Bold first 2 characters of EVERY word`, "boldFirst2CharactersOfEveryWord") // Add menu item.
    .addItem(`Bold all "Normal text"`, "boldAllNormalText") // Add menu item.
    .addToUi(); // Add the menu to the UI.
}
function bionicNormalTextOutsideTable() {
  const body = DocumentApp.getActiveDocument().getBody(); // Get body of document.
  const tables = body.getTables(); // Get all tables.
  const paragraphs = []; // Prepare container for target paragraphs.
  for (let i = 0; i < body.getNumChildren(); i++) { // Loop through children of body.
    const child = body.getChild(i); // Get child element.
    if (child.getType() === DocumentApp.ElementType.PARAGRAPH) { // If element is a paragraph...
      const para = child.asParagraph(); // Cast to paragraph.
      if (!isInsideTable_(para, tables) && para.getHeading() === DocumentApp.ParagraphHeading.NORMAL) // If outside table and normal...
        paragraphs.push(para); // Add to list.
    }
  }
  applyBionicStyleToParagraphs(paragraphs, word => Math.floor((word.length - 1) / 2)); // Apply style.
}
function bionicNonHeaders() {
  const body = DocumentApp.getActiveDocument().getBody(); // Get body.
  const allParagraphs = body.getParagraphs(); // Get all paragraphs.
  const normalParagraphs = allParagraphs.filter(p => p.getHeading() === DocumentApp.ParagraphHeading.NORMAL); // Filter normal text.
  applyBionicStyleToParagraphs(normalParagraphs, word => Math.floor(word.length / 2)); // Apply style.
}
function bionicEveryWord() {
  const body = DocumentApp.getActiveDocument().getBody(); // Get body.
 const text = body.getText(); // Get all text.
 const words = text.split(/\s/); // Split into words.
 let currentPosition = 0; // Position in text.
 for (let j = 0; j < words.length; j++) { // Loop through words.
   const word = words[j];
    if (word.trim() !== "") { // If not empty...
     const start = currentPosition + text.substring(currentPosition).indexOf(word); // Word start.
     const boldLength = Math.ceil(word.length / 2); // Characters to bold.
     const end = start + boldLength; // End of bold.
     if (boldLength > 0) { // Only bold if range valid.
       body.editAsText().setBold(start, end - 1, true); // Bold part of word.
     }
      currentPosition = start + word.length; // Move to next word.
   }
  }
}
function boldFirst2CharactersOfEveryWord() {
  const body = DocumentApp.getActiveDocument().getBody(); // Get body.
  const text = body.getText(); // Get all text.
  const words = text.split(/\s/); // Split into words.
  let currentPosition = 0; // Track position.
  for (let i = 0; i < words.length; i++) { // Iterate words.
    const word = words[i];
    if (word.trim() !== "") { // If not empty...
      const start = currentPosition + text.substring(currentPosition).indexOf(word); // Word start.
      const end = start + Math.min(2, word.length); // End = 2 characters max.
      body.editAsText().setBold(start, end - 1, true); // Bold first 2.
      currentPosition = start + word.length; // Move forward.
    }
  }
}
function boldAllNormalText() {
  const body = DocumentApp.getActiveDocument().getBody(); // Get body.
  const paragraphs = body.getParagraphs(); // Get all paragraphs.
  for (let i = 0; i < paragraphs.length; i++) { // Iterate paragraphs.
    const para = paragraphs[i];
    if (para.getHeading() === DocumentApp.ParagraphHeading.NORMAL) // If normal text...
      para.setBold(true); // Bold all text in paragraph.
  }
}
function boldTextOutsideTable() {
  const body = DocumentApp.getActiveDocument().getBody(); // Get document body.
  const tables = body.getTables(); // Get tables.
  for (let i = 0; i < body.getNumChildren(); i++) { // Iterate children.
    const child = body.getChild(i);
    if (child.getType() === DocumentApp.ElementType.PARAGRAPH) { // If paragraph...
      const para = child.asParagraph(); // Cast.
      if (!isInsideTable_(para, tables)) // If not inside table...
        para.setBold(true); // Bold all.
    }
  }
}
/*************************************** HELPER FUNCTIONS ***************************************/
// Apply bionic-style bolding to a list of paragraphs
function applyBionicStyleToParagraphs(paragraphs) {
  for (let i = 0; i < paragraphs.length; i++) { // Iterate over each paragraph.
    const paragraph = paragraphs[i];
    const text = paragraph.getText(); // Get paragraph text.
    const words = text.split(/\s+/); // Split into words.
    let currentPosition = 0; // Track character index in paragraph.
    for (let j = 0; j < words.length; j++) { // Iterate over words.
      const word = words[j];
      if (word.trim() === "") continue; // Skip empty words.
      const indexInText = text.indexOf(word, currentPosition); // Find word from current position.
      if (indexInText === -1) continue; // Skip if not found.
      const start = indexInText; // Start index of word.
      const charsToBold = Math.ceil(word.length / 2); // Bold >50% for odd lengths.
      const end = start + charsToBold; // End index.
      if (end > start) { // Only apply bold if range is valid.
       paragraph.editAsText().setBold(start, end - 1, true); // Apply bold.
      }
      currentPosition = start + word.length; // Move to next word.
    }
  }
}
// Check if a paragraph is inside any table
function isInsideTable_(paragraph, tables) {
  for (let i = 0; i < tables.length; i++) { // Loop through tables.
    if (isElementInside_(paragraph, tables[i])) return true; // Found inside.
  }
  return false; // Not inside any.
}
// Check if an element is nested inside another
function isElementInside_(element, container) {
  let parent = element.getParent(); // Start from immediate parent.
  while (parent != null) { // Traverse up.
    if (parent.getType() === container.getType() && parent.getId() === container.getId()) // Match by ID and type.
      return true; // Found match.
    parent = parent.getParent(); // Go up.
  }
  return false; // No match found.
}

/**
 * Count words for ALL tabs in a Docs file.
 * At the time of writing, the "Word count" of Google Docs
 * can't count words from multiple Tabs or Subtabs.
 * This script solves that problem.
 * Author: Mr Shane
 * Version: 2025-04-28
 * @see https://developers.google.com/apps-script/guides/docs/tabs
 * @OnlyCurrentDoc
 */
function onOpen() {
  const ui = DocumentApp.getUi(); // Get the user interface for the document
  ui.createMenu("⚠️Admin Menu⚠️") // Create a custom menu.
    .addItem("Count words of ALL Tabs and Subtabs", "countWordsInAllTabs") // Add the menu item.
    .addToUi(); // Add the menu to the UI.
}
function countWordsInAllTabs() {
  const doc = DocumentApp.getActiveDocument(); // Get the active document.
  const ui = DocumentApp.getUi(); // Get the user interface for the document
  const tabs = doc.getTabs(); // Get all top-level Tabs in the document.
  let totalWords = 0; // Initialize total word count.
  const stack = [...tabs]; // Initialize a stack with the top-level Tabs.
  while (stack.length > 0) {
    const currentTab = stack.pop(); // Process the last tab in the stack.
    const documentTab = currentTab.asDocumentTab(); // Convert to a DocumentTab.
    const bodyText = documentTab.getBody().getText(); // Get the body text.
    totalWords += bodyText.trim().split(/\s+/).filter(Boolean).length; // Count words.
    const childTabs = currentTab.getChildTabs(); // Get Subtabs.
    stack.push(...childTabs); // Add Subtabs to the stack for further processing.
  }
  // Display the result to the user.
  ui.alert(
    `Word Count Result`,
    `Total word count across all tabs, subtabs, and sub-subtabs: ${totalWords}`,
    ui.ButtonSet.OK
  );
}

/**
 * Word count for EACH and ALL tabs in a Docs file.
 * At the time of writing, the "Word count" of Google Docs
 * can't count words from multiple Tabs or Subtabs.
 * This script solves that problem.
 * Author: Mr Shane
 * Version: 2024-04-28
 * @see https://developers.google.com/apps-script/guides/docs/tabs
 * @OnlyCurrentDoc
 */
function onOpen() {
  DocumentApp.getUi() // Get the user interface for the document
    .createMenu("⚠️Admin Menu⚠️") // Create a custom menu named "Admin Menu"
    .addItem("Count words in all Tabs and Subtabs", "countWordsInAllTabs") // Add a menu item to trigger word count
    .addToUi(); // Add the menu to the UI
}
function countWordsInAllTabs() {
  const doc = DocumentApp.getActiveDocument(); // Get the active document
  const ui = DocumentApp.getUi(); // Get the user interface for the document
  const allTabs = getAllTabs(doc); // Get a flat list of all tabs and subtabs
  let results = []; // Initialize an array to hold tab titles and word counts
  let totalWords = 0; // Initialize a variable to keep the total word count
  for (const tabInfo of allTabs) { // Loop through each tab
    const { id, title } = tabInfo; // Destructure id and title from tab info
    const documentTab = doc.getTab(id).asDocumentTab(); // Open the tab by ID and get as a DocumentTab
    const bodyText = documentTab.getBody().getText(); // Get the body text of the tab
    const wordCount = bodyText.trim().split(/\s+/).filter(Boolean).length; // Count the words by splitting and filtering empty strings
    totalWords += wordCount; // Add this tab's word count to the total
    results.push(`${title}: ${wordCount} words`); // Add the title and word count to results
  }
  results.push(""); // Add an empty line before total
  results.push(`Total Word Count: ${totalWords} words`); // Add the total word count to the results
  ui.alert( // Show an alert with the word counts
    "Word Count by Tab/Subtab", // Alert title
    results.join("\n"), // Join all tab results with newlines
    ui.ButtonSet.OK // Set alert button
  );
}
/**
 * Returns a flat list of all tabs (ID and Title) in the document, in the order they appear.
 */
function getAllTabs(doc) {
  const allTabs = []; // Initialize an array to collect all tabs
  for (const tab of doc.getTabs()) { // Loop through all top-level tabs
    addCurrentAndChildTabs(tab, allTabs); // Recursively add tab and its children
  }
  return allTabs; // Return the collected tabs
}
/**
 * Recursively adds the current tab and its child tabs.
 */
function addCurrentAndChildTabs(tab, allTabs) {
  allTabs.push({ id: tab.getId(), title: tab.getTitle() }); // Add the current tab's ID and title
  for (const childTab of tab.getChildTabs()) { // Loop through child tabs
    addCurrentAndChildTabs(childTab, allTabs); // Recursively add each child tab
  }
}

/**
 * ATTENTION: Currently, there is no ability to create a document tab.
 *
 * If you want the ability to use Apps Script to create/move tabs in Google Docs,
 * please upvote these IssueTrackers so that Google will see there is good demand for this feature to be developed:
 * @see https://issuetracker.google.com/issues/375867285
 * @see https://issuetracker.google.com/issues/391499599
 *
 * Potential prerequisites: Enable 'Google Docs API'.
 * Documentation
 * @see https://developers.google.com/apps-script/advanced/docs
 * @see https://developers.google.com/workspace/docs/api/concepts/document
 * @see https://developers.google.com/workspace/docs/api/how-tos/tabs#documentscreate
 */

/**
 * ATTENTION: Currently, there is no ability to duplicate a document tab.
 *
 * If you want the ability to use Apps Script to create/move tabs in Google Docs,
 * please upvote these IssueTrackers so that Google will see there is good demand for this feature to be developed:
 * @see https://issuetracker.google.com/issues/375867285
 * @see https://issuetracker.google.com/issues/391499599
 *
 * Potential prerequisites: Enable 'Google Docs API'.
 * Documentation
 * @see https://developers.google.com/apps-script/advanced/docs
 * @see https://developers.google.com/workspace/docs/api/concepts/document
 * @see https://developers.google.com/workspace/docs/api/how-tos/tabs#documentscreate
 */

/** START ONOPEN */
function onOpen(){
  customMenu();
}
/** END ONOPEN */
/** CUSTOM MENU */
function customMenu(){
  const ui = DocumentApp.getUi();
  ui.createMenu("⚠️Admin Menu⚠️")
    .addItem("Convert Doc to PDF in Current Folder v1", "docToPdfCurrentFolder_v1")
    .addItem("Convert Doc to PDF in Current Folder v2", "docToPdfCurrentFolder_v2")
    .addItem("Convert Doc to PDF in Nominated Folder v1", "docToPdfNominatedFolder_v1")
    .addItem("Convert Doc to PDF in Nominated Folder v2", "docToPdfNominatedFolder_v2")
    .addItem("Convert Doc to PDF in Root Directory", "docToPdfRootDir")
  .addToUi()
}
/** END CUSTOM MENU */
/**
 * Export the active Docs file (including all Tabs and Subtabs) to PDF in the current folder.
 * This script maintains the page orientation.
 */
function docToPdfCurrentFolder_v1() {
  const doc = DocumentApp.getActiveDocument(); // Get the active Docs file.
  const docID = doc.getId(); // Get ID of the active Docs file.
  const folderID = DriveApp.getFileById(docID).getParents().next().getId(); // Get ID of the folder the Doc is stored in.
  const folder = DriveApp.getFolderById(folderID); // Get the folder by ID.
  const pdfBlob = doc.getBlob(); // Get the file as a Blob.
  folder.createFile(pdfBlob); // Create the PDF file in Google Drive folder.
}
/**
 * Export the active Docs file (including all Tabs and Subtabs) to PDF in the current folder.
 * This script maintains the page orientation.
 */
function docToPdfCurrentFolder_v2() {
  const doc = DocumentApp.getActiveDocument(); // Get the active Docs file.
  const docID = doc.getId(); // Get ID of the active Docs file.
  const folderID = DriveApp.getFileById(docID).getParents().next().getId(); // Get ID of the folder the Doc is stored in.
  const folder = DriveApp.getFolderById(folderID);  // Get the Drive folder by its ID.
  const pdfBlob = doc.getAs('application/pdf'); // Get the file as a PDF.
  folder.createFile(pdfBlob); // Create the PDF file in Google Drive folder.
}
/**
 * Export the active Docs file (including all Tabs and Subtabs) to PDF in a specified folder.
 * This script maintains the page orientation.
 */
function docToPdfNominatedFolder_v1() {
  const doc = DocumentApp.getActiveDocument(); // Get the active Docs file.
  const folderID = '1RvHowhvddb3JrssUZrytMH6k1zKNN_E8';  // Configure ID of target folder.
  const folder = DriveApp.getFolderById(folderID);  // Get the Drive folder by its ID.
  const pdfBlob = doc.getBlob(); // Get the file as a Blob.
  folder.createFile(pdfBlob);  // create new PDF file in Google Drive folder
}
/**
 * Export the active Docs file (including all Tabs and Subtabs) to PDF in the specified folder.
 * This script maintains the page orientation.
 */
function docToPdfNominatedFolder_v2() {
  const doc = DocumentApp.getActiveDocument(); // Get the active Docs file.
  const folderID = '1RvHowhvddb3JrssUZrytMH6k1zKNN_E8';  // Configure ID of target folder.
  const folder = DriveApp.getFolderById(folderID);  // Get the Drive folder by its ID.
  const pdfBlob = doc.getAs('application/pdf'); // Get the file as a PDF.
  folder.createFile(pdfBlob);  // create new PDF file in Google Drive folder
}
/**
 * Export the active Docs file (including all Tabs and Subtabs) to PDF in the root directory.
 * This script maintains the page orientation.
 */
function docToPdfRootDir() {
  const doc = DocumentApp.getActiveDocument();
  const ui = DocumentApp.getUi();
  const result = ui.alert(
      'Save As PDF?',
      'Save current document (Name: ' + doc.getName() + '.pdf) as PDF',
      ui.ButtonSet.YES_NO);
  if (result === ui.Button.YES) {
    let docBlob = doc.getAs('application/pdf');
    docBlob.setName(doc.getName() + ".pdf");
    const file = DriveApp.createFile(docBlob);
    ui.alert('Your PDF file is available at ' + file.getUrl());
  } else {
    ui.alert('Request has been cancelled.');
  }
}

/**
 * Export the active tab as PDF (without the extra tab title page).
 * @see https://developers.google.com/apps-script/guides/docs/tabs
 *
 * Author: Mr Shane
 * Version: 2025-09-12
 */
function createPDFActiveTab() {
  const doc = DocumentApp.getActiveDocument();
  const tab = doc.getActiveTab();
  const url = `https://docs.google.com/document/d/${doc.getId()}/export?format=pdf&tab=${tab.getId()}`;
  const params = {headers: {"Authorization": 'Bearer ' + ScriptApp.getOAuthToken()}};
  const response = UrlFetchApp.fetch(url, params);
  const blob = response.getBlob();
  DriveApp.createFile(blob.setName(tab.getTitle()));
}

/**
 * replaceText() Find
 * "\\s*" = any spaces
 * "\\t" = tabs
 * "\\v" = soft returns
 * "^\\s+" = leading spaces (at beginning of paragraphs)
 * "\\s+$" = trailing spaces (at end of paragraphs)
 *
 * replaceText() Replace
 * "\t" = tabs
 * "\n" = new-lines
 * "^\\s+" = leading spaces (at beginning of paragraphs)
 * "\\s+$" = trailing spaces (at end of paragraphs)
 *
 * getText().replace() Find (WARNING: ALL formatting will be removed when using the getText().replace() & setText() methods!)
 * /\t/g = tabs
 * /\n/g = new-lines
 * /\n\n/g = double new-lines
 *
 * getText().replace() Replace (WARNING: ALL formatting will be removed when using the getText().replace() & setText() methods!)
 * "\t" = tabs
 * "\n" = new-lines
 */

/**
 * Find & replace in the selected text.
 * Pros: Maintains the text formatting
 * Cons: Is case sensitive.
 */
function multipleFindAndReplace() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const s = doc.getSelection(); // Get the current selection.
  if (s) {
    s.getRangeElements().forEach(e => {
      e.getElement().replaceText("find", "replace");
      e.getElement().replaceText("Find", "Replace");
    })
  } else {
    DocumentApp.getUi().alert('No text selected. Please select some text and try again.');
  }
}
/**** Docs Custom Menu **************************************************************************/
function onOpen() {
  DocumentApp.getUi().createMenu("⚠️Admin Menu⚠️") // Create a custom menu
    .addItem('Replace Space with Tabs - ALL', 'replaceSpacesWithTabsAll')
    .addItem('Replace Space with Tabs - Beginning of Paragraphs Only', 'replaceSpacesWithTabsParagraphStart')
    .addItem('Replace Space with Tabs - Selected Text Only', 'replaceSpacesWithTabsSelectedText')
    .addItem('Replace Comma-Space with Newline - Selected Text Only', 'replaceCommaSpacesWithNewlineSelectedText')
    .addItem('Replace Space-Hyphen-Space with Newline - Selected Text Only', 'rreplaceSpaceHyphenSpaceWithNewlineSelectedText')
    .addItem('Remove Leading & Trailing Spaces - At Beginning & End of Paragraphs', 'removeSpacesParagraphStartEnd')
    .addSeparator()
    .addItem('Replace Tabs with Newline - Within Text Only', 'replaceTabsWithNewlineInText')
    .addItem('Replace Tabs with Newline - ALL (ALL formatting will be removed)', 'replaceTabsWithNewLineAll')
    .addSeparator()
    .addItem('Reset Leading "First line indent" tabs to 0', 'setFirstLineIndentToZero')
    .addSeparator()
    .addItem('Add a New Line After Each Paragraph', 'addNewLineAfterParagraphs')
    .addSeparator()
    .addItem('Replace Double Newline with Single Newline - ALL (ALL formatting will be removed)', 'setTextdoubleNewlineToSingleNewline')
    .addItem('Replace Double Newline with Single Newline - ALL', 'doubleNewlineToSingleNewline')
    .addItem('Replace Double Newline with Double Newline + Opening Quotes - ALL (ALL formatting will be removed)', 'doubleNewlineToDoubleNewlineDoubleQuotes')
    .addItem('Replace Double Newline with Double Newline + Opening Quotes - ALL', 'afterDoubleNewlineAddDoubleQuoteInFront')
    .addItem('Replace Double Newline with Double Newline + Opening & Closing Quotes - ALL', 'afterDoubleNewlineWrapWithDoubleQuotes')
    .addItem('Replace Double Newline with Double Newline + Opening & Closing Quotes - Selected Text Only', 'wrapDoubleQuotesToSelectedParagraphs')
    .addItem('Add a New Line After Each Paragraph.', 'addNewLineAfterParagraphs')
    .addSeparator()
    .addItem('Replace Hard Returns with Soft Returns - ALL', 'replaceHardWithSoft')
    .addToUi();
}

/**** REPLACE SPACES ****************************************************************************/
/**
 * Replace Space with Tabs - ALL
 */
function replaceSpacesWithTabsAll() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const body = doc.getBody(); // Get the document body.
  body.editAsText().replaceText("\\s*", "\t"); // Replace ALL spaces with tabs.
}
/**
 * Replace Space with Tabs - At Beginning of Paragraphs Only
 */
function replaceSpacesWithTabsParagraphStart() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const body = doc.getBody(); // Get the document body.
  const paragraphs = body.getParagraphs(); // Get the paragraphs in the body.
  for ( i=0 ; i < paragraphs.length; i++) {
    paragraphs[i].replaceText("^\\s+", "\t"); // Replace leading spaces with tabs.
  }
}
/**
 * Replace Space with Tabs - Range Element of Selected Text Only
 */
function replaceSpacesWithTabsSelectedText() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const s = doc.getSelection(); // Get the current selection.
  if (s) {
    s.getRangeElements().forEach(e => {
      e.getElement().replaceText("\\s*", "\t");
    })
  } else {
    DocumentApp.getUi()
      .alert('No text selected. Please select some text and try again.');
  }
}
/**
 * Replace Comma-Space with Newline - Range Element of Selected Text Only
 */
function replaceCommaSpacesWithNewlineSelectedText() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const s = doc.getSelection(); // Get the current selection.
  if (s) {
    s.getRangeElements().forEach(e => {
      e.getElement().replaceText(",\\s*", "\n");
    })
  } else {
    DocumentApp.getUi().alert('No text selected. Please select some text and try again.');
  }
}
/**
 * Replace Space-Hyphen-Space with Newline - Range Element of Selected Text Only
 */
function replaceSpaceHyphenSpaceWithNewlineSelectedText() {
  const doc = DocumentApp.getActiveDocument(); // Get the active document.
  const s = doc.getSelection(); // Get the current selection.
  if (s) {
    s.getRangeElements().forEach(e => {
      e.getElement().replaceText(" - ", "\n");
    });
  } else {
    DocumentApp.getUi().alert('No text selected. Please select some text and try again.');
  }
}

/**** REMOVE SPACES *****************************************************************************/
/**
 * Remove Leading & Trailing Spaces - At Beginning & End of Paragraphs
 */
function removeSpacesParagraphStartEnd() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const body = doc.getBody(); // Get the document body.
  const p = body.getParagraphs(); // Get the paragraphs in the body.
  for ( i=0 ; i < p.length; i++) {
    p[i].replaceText("^\\s+", ""); // Remove leading spaces.
    p[i].replaceText("\\s+$", ""); // Remove trailing spaces.
 }
}

/**** REPLACE TABS ******************************************************************************/
/**
 * Replace Tabs with Newline - Within Text Only
 * NOTE: This will NOT replace "First line indent" at the beginning of paragraphs.
 */
function replaceTabsWithNewlineInText() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const body = doc.getBody(); // Get the document body.
  body.editAsText().replaceText("\\t", "\n");
}
/**
 * Replace Tabs with Newline - ALL
 * WARNING: ALL formatting will be removed when using the replace() & setText() methods!
 */
function replaceTabsWithNewLineAll() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const body = doc.getBody(); // Get the document body.
  const bodyText = body.getText(); // Get the text from the body.
  const textReplacement = bodyText.replace(/\t/g, "\n");
  body.setText( textReplacement );
}

/**** RESET FIRST LINE INDENT *******************************************************************/
/**
 * Reset Leading "First line indent" tabs to 0
 */
function setFirstLineIndentToZero() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const body = doc.getBody(); // Get the document body.
  const paragraphs = body.getParagraphs(); // Get the paragraphs in the body.
  for (let i = 0; i < paragraphs.length; i++) {
    const paragraph = paragraphs[i];
    paragraph.setAttributes({ INDENT_FIRST_LINE: 0 });
  }
}

/**** ADD NEW-LINE ******************************************************************************/
/**
 * Add a New Line After Each Paragraph.
 * NOTE: A new line is effectively the beginning of a new paragraph.
 */
function addNewLineAfterParagraphs() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const body = doc.getBody(); // Get the document body.
  const paragraphs = body.getParagraphs(); // Get the paragraphs in the body.
  paragraphs.forEach(paragraph => {
    paragraph.appendText("\n");
  });
}

/**** REPLACE DOUBLE NEW-LINE *******************************************************************/
/**
 * Replace Double Newline with Single Newline - ALL
 * WARNING: ALL formatting will be removed when using the replace() & setText() methods!
 */
function setTextdoubleNewlineToSingleNewline() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const body = doc.getBody(); // Get the document body.
  const bodyText = body.getText(); // Get the text from the body.
  const textReplacement = bodyText.replace( /\n\n/g, "\n" );
  body.setText( textReplacement );
}
/**
 * Replace Double Newline with Single Newline - ALL.
 * NOTE: A new line is effectively the beginning of a new paragraph.
 */
function doubleNewlineToSingleNewline() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const body = doc.getBody(); // Get the document body.
  const paragraphs = body.getParagraphs(); // Get the paragraphs in the body.
  for (let i = 1; i < paragraphs.length; i++) { // Loop through paragraphs starting from the second one
    const previousParagraph = paragraphs[i - 1]; // Get the previous paragraph
    const currentParagraph = paragraphs[i]; // Get the current paragraph
    if (previousParagraph.getText().trim() === "" && currentParagraph.getText().trim() !== "") { // Check if the previous paragraph is empty and the current paragraph is not
      previousParagraph.removeFromParent(); // Remove the previous paragraph from its parent (the body)
    }
  }
}
/**
 * Replace Double Newline with Double Newline + Opening Quotes - ALL
 * WARNING: ALL formatting will be removed when using the replace() & setText() methods!
 */
function doubleNewlineToDoubleNewlineDoubleQuotes() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const body = doc.getBody(); // Get the document body.
  const bodyText = body.getText(); // Get the text from the body.
  const textReplacement = bodyText.replace( /\n\n/g, '\n\n"' );
  body.setText( textReplacement );
}
/**
 * Replace Double Newline with Double Newline + Opening Quotes - ALL.
 * NOTE: A new line is effectively the beginning of a new paragraph.
 */
function afterDoubleNewlineAddDoubleQuoteInFront() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const body = doc.getBody(); // Get the document body.
  const paragraphs = body.getParagraphs(); // Get the paragraphs in the body.
  for (let i = 1; i < paragraphs.length; i++) {
    const previousParagraph = paragraphs[i - 1];
    const currentParagraph = paragraphs[i];
    if ( previousParagraph.getText().trim() === "" && currentParagraph.getText().trim() !== "" ) {
      currentParagraph.insertText(0, '"');
    }
  }
}
/**
 * Replace Double Newline with Double Newline + Opening & Closing Quotes - ALL.
 * NOTE: A new line is effectively the beginning of a new paragraph.
 */
function afterDoubleNewlineWrapWithDoubleQuotes() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const body = doc.getBody(); // Get the document body.
  const paragraphs = body.getParagraphs(); // Get the paragraphs in the body.
  for (let i = 1; i < paragraphs.length; i++) {
    const previousParagraph = paragraphs[i - 1];
    const currentParagraph = paragraphs[i];
    if ( previousParagraph.getText().trim() === "" && currentParagraph.getText().trim() !== "" ) {
      currentParagraph.insertText(0, '"');
      currentParagraph.appendText('"');
    }
  }
}
/**
 * Replace Double Newline with Double Newline + Opening & Closing Quotes - Range Element of Selected Text Only.
 * NOTE: A new line is effectively the beginning of a new paragraph.
 * ATTENTION: This script requires you select a new line AFTER the last paragraph to be effected.
 */
function wrapDoubleQuotesToSelectedParagraphs() {
  const doc = DocumentApp.getActiveDocument(); // Get the activeDocument.
  const s = doc.getSelection(); // Get the current selection.
  if (s) {
    const paragraphs = s.getRangeElements()
      .map(element => element.getElement())
      .filter(element => element.getType() === DocumentApp.ElementType.PARAGRAPH);
    for (let i = 1; i < paragraphs.length; i++) {
      const previousParagraph = paragraphs[i - 1];
      const currentParagraph = paragraphs[i];
      if ( previousParagraph.getText().trim() === "" && currentParagraph.getText().trim() !== "" ) {
        currentParagraph.insertText(0, '"');
        currentParagraph.appendText('"');
      }
    }
  } else {
    DocumentApp.getUi().alert('No text selected. Please select some text and try again.');
  }
}

/**** REPLACE HARD RETURNS ***********************************************************************/
/**
 * Replace ALL hard returns with soft returns
 * Prerequisites: Google Docs API is enabled.
 * Author: Mr Shane
 * Version: 2025-04-24
 * @see https://developers.google.com/workspace/docs/api/reference/rest/v1/documents/batchUpdate
 * @see https://developers.google.com/workspace/docs/api/reference/rest/v1/documents/request#replacealltextrequest
 */
function replaceHardWithSoft() {
  const doc = DocumentApp.getActiveDocument();
  const requests = [
      {
      replaceAllText: {
        containsText: { text: '\n' }, // find hard return new lines
        replaceText: '\v'  // replace with soft return new lines
      }
    }
  ];
  Docs.Documents.batchUpdate({ requests }, doc.getId());
}

/**
 * Format rows of a Docs table with alternating colours
 * Author: Mr Shane
 * Version: 2024-06-14
 * Prerequisites: Must have double clicked a cell in a table so that it's highlighted.
 * @OnlyCurrentDoc
 */
function onOpen(e) {
  // Functions to run onOpen (eg: a custom menu)
  customMenu();
}
function customMenu(){
  const ui = DocumentApp.getUi();
  ui.createMenu("⚠️Admin Menu⚠️")
    .addItem("🚧 Banded rows", "changeTableRowColors_")
    .addToUi()
}
function changeTableRowColors_() {
  const doc = DocumentApp.getActiveDocument();
  const selection = doc.getSelection();
  const ui = DocumentApp.getUi();
  if (!selection) {
    ui.alert('Double click a cell in a table, until it is highlighted, then run the script again.');
    return;
  }
  const elements = selection.getRangeElements();
  for (let i = 0; i < elements.length; i++) {
    let element = elements[i].getElement();
    while (element) {
      if (element.getType() === DocumentApp.ElementType.TABLE_CELL) {
        const table = getTableFromCell_(element);
        if (table) {
          changeRowColors_(table);
          ui.alert('Background color of every second row has been changed to light grey.');
        }
        return;
      }
      element = element.getParent();
    }
  }
  ui.alert('You have selected text that is not in a table.\n\nDouble click a cell in a table, until it is highlighted, then run the script again.');
}
function getTableFromCell_(cell) {
  let row = cell.getParent();
  while (row && row.getType() !== DocumentApp.ElementType.TABLE_ROW) {
    row = row.getParent();
  }
  if (!row) { return null; }
  let table = row.getParent();
  while (table && table.getType() !== DocumentApp.ElementType.TABLE) {
    table = table.getParent();
  }
  return table;
}
function changeRowColors_(table) {
  const numRows = table.getNumRows();
  for (let i = 1; i < numRows; i += 2) {
    const row = table.getRow(i);
    const numCells = row.getNumCells();
    for (let j = 0; j < numCells; j++) {
      const cell = row.getCell(j);
      cell.setBackgroundColor('#D3D3D3');  // Light grey color
    }
  }
}

/**
 * Case sensitive formatting all instances of selected text.
 * Author: Mr Shane
 * Version: 2025-05-13
 */
// Adds a custom menu on open
function onOpen() {
  const ui = DocumentApp.getUi(); // Get UI object
  ui.createMenu("⚠️Admin Menu⚠️") // Create a custom menu
    .addItem("Bold ALL instances of selected text (Case Sensitive)", "boldAllInstancesOfSelected") // Add bold option
    .addItem("Italic ALL instances of selected text (Case Sensitive)", "italicAllInstancesOfSelected") // Add italic option
    .addItem("Colour ALL instances of selected text (Case Sensitive)", "colourAllInstancesOfSelected") // Add colour option
    .addToUi(); // Add menu to UI
}
// Bolds all instances of selected text
function boldAllInstancesOfSelected() {
  handleTextFormatting((text, start, end) => text.setBold(start, end, true), "bolded"); // Apply bold formatting
}
// Italicizes all instances of selected text
function italicAllInstancesOfSelected() {
  handleTextFormatting((text, start, end) => text.setItalic(start, end, true), "italicized"); // Apply italic formatting
}
// Colours all instances of selected text
function colourAllInstancesOfSelected() {
  const selectedText = getSelectedText(); // Extract selected text
  if (!selectedText) return; // Stop if no valid selection
  const ui = DocumentApp.getUi(); // Get UI
  const response = ui.prompt(`Enter a hex color for "${selectedText}" (e.g., FF5733 or #FF5733):`, ui.ButtonSet.OK_CANCEL); // Ask for color
  if (response.getSelectedButton() !== ui.Button.OK) return; // Exit if cancelled
  let color = response.getResponseText().trim().toUpperCase(); // Format color input
  if (!/^#?[0-9A-F]{6}$/i.test(color)) { // Validate hex format
    ui.alert('Invalid hex code! Please enter a valid 6-digit hex color.'); // Alert on error
    return;
  }
  if (!color.startsWith('#')) color = `#${color}`; // Add '#' if missing
  handleTextFormatting((text, start, end) => text.setForegroundColor(start, end, color), `recoloured to "${color}"`, selectedText); // Apply color
}
/******************************************* HELPER FUNCTIONS *******************************************/
// Gets selected text from user selection
function getSelectedText() {
  const selection = DocumentApp.getActiveDocument().getSelection(); // Get selected content
  if (!selection) {
    DocumentApp.getUi().alert('Please select the text.'); // Alert if nothing selected
    return null;
  }
  const selectedText = selection.getRangeElements() // Get selected range elements
    .filter(el => el.getElement().editAsText()) // Keep only text elements
    .map(el => el.getElement().asText().getText().substring(el.getStartOffset(), el.getEndOffsetInclusive() + 1)) // Extract text
    .join('');
  if (!selectedText.trim()) {
    DocumentApp.getUi().alert('No valid text selected.'); // Alert on empty or whitespace
    return null;
  }
  return selectedText; // Return trimmed text
}
// Handles formatting logic for bold, italic, colour
function handleTextFormatting(applyStyleFn, actionLabel, customText) {
  const doc = DocumentApp.getActiveDocument(); // Get document
  const text = doc.getBody().editAsText(); // Get editable text
  const targetText = customText || getSelectedText(); // Use provided or selected text
  if (!targetText) return; // Exit if no text
  let index = -1, occurrences = 0; // Initialize
  while ((index = text.getText().indexOf(targetText, index + 1)) !== -1) { // Loop through all instances
    applyStyleFn(text, index, index + targetText.length - 1); // Apply formatting
    occurrences++; // Count
  }
  DocumentApp.getUi().alert(`All ${occurrences} instances of "${targetText}" have been ${actionLabel}.`); // Show result
}