Skip to content

[excel] (Samples) Adjust how the samples and scenarios are branded #686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Use Office Scripts in Excel to automate your common tasks. Explore the following
</div>
</div>
<div class="cardText">
<h3>Getting started</h3>
<h3>Get started</h3>
<p><a href="tutorials/excel-tutorial.md">Create and format a table with Office Scripts.</a></p>
</div>
</div>
Expand All @@ -56,8 +56,8 @@ Use Office Scripts in Excel to automate your common tasks. Explore the following
</div>
</div>
<div class="cardText">
<h3>Scripting fundamentals</h3>
<p><a href="develop/scripting-fundamentals.md">Learn the fundamental concepts of scripting with Office Scripts in Excel.</a></p>
<h3>Script fundamentals</h3>
<p><a href="develop/scripting-fundamentals.md">Learn the basics of making Office Scripts in Excel.</a></p>
</div>
</div>
</div>
Expand Down
8 changes: 4 additions & 4 deletions docs/resources/samples/add-excel-comments.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Add comments in Excel
description: Learn how to use Office Scripts to add comments in a worksheet.
ms.date: 10/20/2023
title: Notify people with comments
description: Learn how to use Office Scripts to add comments in a worksheet that notify users with @mentions.
ms.date: 12/05/2023
ms.localizationpriority: medium
---

# Add comments in Excel
# Notify people with comments

This sample shows how to add comments to a cell including [@mentioning](https://support.microsoft.com/office/90701709-5dc1-41c7-aa48-b01d4a46e8c7) a colleague.

Expand Down
8 changes: 4 additions & 4 deletions docs/resources/samples/range-samples.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Ranges in Office Scripts
description: A collection of code samples showing how to work with Excel ranges in Office Scripts.
ms.date: 09/08/2023
title: 'Ranges: Work with the grid in Office Scripts'
description: A collection of code samples showing how to work with Excel ranges, collections of cells, in Office Scripts.
ms.date: 12/05/2023
ms.localizationpriority: medium
---

# Ranges in Office Scripts
# Ranges: Work with the grid in Office Scripts

The following samples are simple scripts for you to try on your own workbooks. They form the building blocks to larger solutions. Expand these scripts to extend your solution and solve common problems.

Expand Down
54 changes: 31 additions & 23 deletions docs/resources/samples/samples-overview.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
---
title: Office Scripts samples
description: Available Office Scripts samples and scenarios.
ms.date: 09/20/2023
ms.date: 12/05/2023
ms.localizationpriority: medium
---

# Office Scripts samples and scenarios

This section contains [Office Scripts](../../overview/excel.md) based solutions that help end users achieve automation of daily tasks. It contains realistic scenarios that users face and provides detailed solutions.

- [Basics](#basics) showcase common examples that make up larger scripts. Most don't need a specific workbook or dataset and can be run in the workbook of your choice.
- [Beyond the basics](#beyond-the-basics) are samples that are more involved or solve a particular problem. Some use Power Automate with an Office Script as a integral part of the flow.
- [Scenarios](#scenarios) are a few larger samples that demonstrate real-world use cases.
- [Basics](#basics) showcase common examples that make up larger scripts. They're categorized based on a common Excel feature.
- [Quick scenarios](#quick-scenarios) are samples that are more involved or solve a particular problem.
- [Cross-application scenarios](#cross-application-scenarios) are samples that use Power Automate with one or more Office Scripts as integral parts of the flow.
- [Real-world scenarios](#real-world-scenarios) are a few larger samples framed as complete, real-world solutions.
- [Contributions from the community](#community-contributions-and-fun-samples) are samples from members of the Office Scripts community, often light-hearted in nature.

> [!IMPORTANT]
Expand All @@ -21,38 +22,45 @@ This section contains [Office Scripts](../../overview/excel.md) based solutions

| Project | Details |
|---------|---------|
| [Range samples](range-samples.md) | These samples show how to work the `Range` object, which is central to most scripts. |
| [Table samples](table-samples.md) | A collection of samples that show common interactions with Excel tables.
| [Add comments in Excel](add-excel-comments.md) | This sample adds comments to a cell including @mentioning a colleague. |
| [Add images to a workbook](add-image-to-workbook.md) | This sample adds an image to a workbook and copies an image across sheets.|
| [Copy multiple Excel tables into a single table](copy-tables-combine.md) | This sample combines data from multiple Excel tables into a single table that includes all the rows. |
| [Data validation: dropdown lists, prompts, and warning pop-ups](data-validation-samples.md) | These samples show how to use data validation to mandate specific conditions for cell data and how the user is alerted to these rules. |
| [Create a workbook table of contents](table-of-contents.md) | This sample creates a table of contents with links to each worksheet. |
| [JavaScript `Date` samples](javascript-dates.md) | A collection of samples that show how to translate between JavaScript and Excel date formats. |
| [Record day-to-day changes in Excel and report them with a Power Automate flow](report-day-to-day-changes.md) | This sample uses a scheduled Power Automate flow to record daily readings and report the changes. |
| [Ranges: Work with the grid](range-samples.md) | These samples show how to work the `Range` object, which is central to most scripts. |
| [Data validation samples: Dropdown lists, prompts, and warning pop-ups](data-validation-samples.md) | These samples show how to use data validation to mandate specific conditions for cell data and how the user is alerted to these rules. |
| [Date samples](javascript-dates.md) | A collection of samples that show how to translate between JavaScript and Excel date formats. |
| [Image samples](add-image-to-workbook.md) | This sample adds an image to a workbook and copies an image across sheets.|
| [Row and column visibility samples](row-and-column-visibility.md) | A collection of samples that demonstrate how to show, hide, and freeze rows and columns. |
| [Run a script on all Excel files in a folder](automate-tasks-on-all-excel-files-in-folder.md) | This project performs a set of automation tasks on all files situated in a folder on OneDrive for Business (can also be used for a SharePoint folder). It performs calculations on the Excel files, adds formatting, and inserts a comment that @mentions a colleague. |
| [Set conditional formatting for cross-column comparisons](conditional-formatting-parameters.md) | This sample applies formatting based on values in adjacent columns. It also gets user input through script parameters. |
| [Table samples](table-samples.md) | A collection of samples that show common interactions with Excel tables. |

## Beyond the basics
## Quick scenarios

Check out the following end-to-end project that automates sample scenarios along with full scripts, sample Excel files used, and [videos (hosted on YouTube)](https://www.youtube.com/playlist?list=PLr3zVPZrMOUMl88fs8uc2GGAePRnNe6m0).
Be sure to download the sample workbooks included with each sample. That lets you skip setup and understand the core concept the sample demonstrates.

| Project | Details |
|---------|---------|
| [Combine worksheets into a single workbook](combine-worksheets-into-single-workbook.md) | This sample uses Office Scripts and Power Automate to pull data from other workbooks into a single workbook. |
| [Convert CSV files to Excel workbooks](convert-csv.md) | This sample uses Office Scripts and Power Automate to create .xlsx files from .csv files. |
| [Cross-reference workbooks](excel-cross-reference.md) | This sample uses Office Scripts and Power Automate to cross-reference and validate information in different workbooks. |
| [Copy multiple Excel tables into a single table](copy-tables-combine.md) | This sample combines data from multiple Excel tables into a single table that includes all the rows. |
| [Create a workbook table of contents](table-of-contents.md) | This sample creates a table of contents with links to each worksheet. |
| [Count blank rows in a specific sheet or in all sheets](count-blank-rows.md) | This sample detects if there are any blank rows in sheets where you anticipate data to be present and then report the blank row count for usage in a Power Automate flow. |
| [Email chart and table images](email-images-chart-table.md) | This sample uses Office Scripts and Power Automate actions to create a chart and send that chart as an image by email. |
| [Manage calculation mode in Excel](excel-calculation.md) | This sample shows how to use the calculation mode and calculate methods in Excel using Office Scripts. |
| [Move rows across tables](move-rows-across-tables.md) | This sample shows how to move rows across tables by saving filters, then processing and reapplying the filters. |
| [Notify people with comments](add-excel-comments.md) | This sample adds comments to a cell including @mentioning a colleague. |
| [Output Excel data as JSON](get-table-data.md) | This solution shows how to output Excel table data as JSON to use in Power Automate. |
| [Remove hyperlinks from each cell in an Excel worksheet](remove-hyperlinks-from-cells.md) | This sample clears all of the hyperlinks from the current worksheet. |
| [Set conditional formatting for cross-column comparisons](conditional-formatting-parameters.md) | This sample applies formatting based on values in adjacent columns. It also gets user input through script parameters. |
| [Use external fetch calls](external-fetch-calls.md) | This sample uses `fetch` to get information from GitHub for the script. |
| [Write a large dataset](write-large-dataset.md) | This sample shows how to send a large range as smaller subranges. |

## Scenarios
## Cross-application scenarios

Use [Power Automate](https://make.powerautomate.com/) to connect other applications to Excel. Have your scripts power emails, forms, Teams messages, and more. These samples include step-by-step instructions to create each Power Automate flow.

| Project | Details |
|---------|---------|
| [Combine worksheets into a single workbook](combine-worksheets-into-single-workbook.md) | This sample uses Office Scripts and Power Automate to pull data from other workbooks into a single workbook. |
| [Convert CSV files to Excel workbooks](convert-csv.md) | This sample uses Office Scripts and Power Automate to create .xlsx files from .csv files. |
| [Cross-reference workbooks](excel-cross-reference.md) | This sample uses Office Scripts and Power Automate to cross-reference and validate information in different workbooks. |
| [Email chart and table images](email-images-chart-table.md) | This sample uses Office Scripts and Power Automate actions to create a chart and send that chart as an image by email. |
| [Record day-to-day changes in Excel and report them with a flow](report-day-to-day-changes.md) | This sample uses a scheduled Power Automate flow to record daily readings and report the changes. |
| [Run a script on all Excel files in a folder](automate-tasks-on-all-excel-files-in-folder.md) | This sample performs a set of automation tasks on all files situated in a folder on OneDrive for Business (can also be used for a SharePoint folder). It performs calculations on the Excel files, adds formatting, and inserts a comment that @mentions a colleague. |
| [Write a large dataset](write-large-dataset.md) | This sample shows how to work with a large range as smaller subranges. This helps flows handle data transfer limits and operation timeouts. |

## Real-world scenarios

Office Scripts can automate parts of your daily routine. These day-to-day tasks often exist in unique ecosystems, with Excel workbooks that are set up in particular ways. These larger scenario samples demonstrate such real-world use-cases. They include both the Office Scripts and the workbooks, so you can see the scenario from end to end.

Expand Down
58 changes: 30 additions & 28 deletions docs/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,57 +66,59 @@ items:
href: resources/samples/samples-overview.md
- name: Basics
items:
- name: Ranges
- name: 'Ranges: Work with the grid'
href: resources/samples/range-samples.md
- name: Tables
href: resources/samples/table-samples.md
- name: 'Data validation: Dropdown lists, prompts, and warning pop-ups'
href: resources/samples/data-validation-samples.md
- name: Dates
href: resources/samples/javascript-dates.md
- name: Add comments
href: resources/samples/add-excel-comments.md
- name: Add images to a workbook
- name: Images
href: resources/samples/add-image-to-workbook.md
- name: Row and column visibility
href: resources/samples/row-and-column-visibility.md
- name: Tables
href: resources/samples/table-samples.md
- name: Quick scenarios
items:
- name: Copy multiple tables into single table
href: resources/samples/copy-tables-combine.md
- name: "Data validation: dropdown lists, prompts, and warning pop-ups"
href: resources/samples/data-validation-samples.md
- name: Create a workbook table of contents
href: resources/samples/table-of-contents.md
- name: Count blank rows in worksheets
href: resources/samples/count-blank-rows.md
- name: Manage calculation mode
href: resources/samples/excel-calculation.md
- name: Move selected rows across tables
href: resources/samples/move-rows-across-tables.md
- name: Notify people with comments
href: resources/samples/add-excel-comments.md
- name: Output table data as JSON
href: resources/samples/get-table-data.md
- name: Remove hyperlinks from Excel cells
href: resources/samples/remove-hyperlinks-from-cells.md
- name: Remove table column filters
href: resources/samples/clear-table-filter-for-active-cell.md
- name: Report day-to-day changes in Power Automate
href: resources/samples/report-day-to-day-changes.md
- name: Row and column visibility
href: resources/samples/row-and-column-visibility.md
- name: Run a script on all Excel files in a folder
href: resources/samples/automate-tasks-on-all-excel-files-in-folder.md
- name: Set conditional formatting for cross-column comparisons
href: resources/samples/conditional-formatting-parameters.md
- name: Beyond the basics
- name: Use external fetch calls in Office Scripts
href: resources/samples/external-fetch-calls.md
- name: Cross-application scenarios
items:
- name: Combine worksheets into a single workbook
href: resources/samples/combine-worksheets-into-single-workbook.md
- name: Convert CSV files
href: resources/samples/convert-csv.md
- name: Cross-reference worksheets
href: resources/samples/excel-cross-reference.md
- name: Count blank rows in worksheets
href: resources/samples/count-blank-rows.md
- name: Email images of chart and table
href: resources/samples/email-images-chart-table.md
- name: Manage calculation mode
href: resources/samples/excel-calculation.md
- name: Move selected rows across tables
href: resources/samples/move-rows-across-tables.md
- name: Output table data as JSON
href: resources/samples/get-table-data.md
- name: Remove hyperlinks from Excel cells
href: resources/samples/remove-hyperlinks-from-cells.md
- name: Use external fetch calls in Office Scripts
href: resources/samples/external-fetch-calls.md
- name: Report day-to-day changes in Power Automate
href: resources/samples/report-day-to-day-changes.md
- name: Run a script on all Excel files in a folder
href: resources/samples/automate-tasks-on-all-excel-files-in-folder.md
- name: Write a large dataset
href: resources/samples/write-large-dataset.md
- name: Scenarios
- name: Real-world scenarios
items:
- name: Analyze web downloads
href: resources/scenarios/analyze-web-downloads.md
Expand Down