Skip to content

Commit 997ebd6

Browse files
[excel] (Samples) Adjust how the samples and scenarios are branded (#686)
* Organize samples to better separate complexity * Add description * Update TOC * Apply suggestions from code review Co-authored-by: Elizabeth Samuel <[email protected]> * PR feedback --------- Co-authored-by: Elizabeth Samuel <[email protected]>
1 parent 5953a0f commit 997ebd6

File tree

5 files changed

+72
-62
lines changed

5 files changed

+72
-62
lines changed

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Use Office Scripts in Excel to automate your common tasks. Explore the following
3939
</div>
4040
</div>
4141
<div class="cardText">
42-
<h3>Getting started</h3>
42+
<h3>Get started</h3>
4343
<p><a href="tutorials/excel-tutorial.md">Create and format a table with Office Scripts.</a></p>
4444
</div>
4545
</div>
@@ -56,8 +56,8 @@ Use Office Scripts in Excel to automate your common tasks. Explore the following
5656
</div>
5757
</div>
5858
<div class="cardText">
59-
<h3>Scripting fundamentals</h3>
60-
<p><a href="develop/scripting-fundamentals.md">Learn the fundamental concepts of scripting with Office Scripts in Excel.</a></p>
59+
<h3>Script fundamentals</h3>
60+
<p><a href="develop/scripting-fundamentals.md">Learn the basics of making Office Scripts in Excel.</a></p>
6161
</div>
6262
</div>
6363
</div>

docs/resources/samples/add-excel-comments.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Add comments in Excel
3-
description: Learn how to use Office Scripts to add comments in a worksheet.
4-
ms.date: 10/20/2023
2+
title: Notify people with comments
3+
description: Learn how to use Office Scripts to add comments in a worksheet that notify users with @mentions.
4+
ms.date: 12/05/2023
55
ms.localizationpriority: medium
66
---
77

8-
# Add comments in Excel
8+
# Notify people with comments
99

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

docs/resources/samples/range-samples.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Ranges in Office Scripts
3-
description: A collection of code samples showing how to work with Excel ranges in Office Scripts.
4-
ms.date: 09/08/2023
2+
title: 'Ranges: Work with the grid in Office Scripts'
3+
description: A collection of code samples showing how to work with Excel ranges, collections of cells, in Office Scripts.
4+
ms.date: 12/05/2023
55
ms.localizationpriority: medium
66
---
77

8-
# Ranges in Office Scripts
8+
# Ranges: Work with the grid in Office Scripts
99

1010
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.
1111

docs/resources/samples/samples-overview.md

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
---
22
title: Office Scripts samples
33
description: Available Office Scripts samples and scenarios.
4-
ms.date: 09/20/2023
4+
ms.date: 12/05/2023
55
ms.localizationpriority: medium
66
---
77

88
# Office Scripts samples and scenarios
99

1010
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.
1111

12-
- [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.
13-
- [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.
14-
- [Scenarios](#scenarios) are a few larger samples that demonstrate real-world use cases.
12+
- [Basics](#basics) showcase common examples that make up larger scripts. They're categorized based on a common Excel feature.
13+
- [Quick scenarios](#quick-scenarios) are samples that are more involved or solve a particular problem.
14+
- [Cross-application scenarios](#cross-application-scenarios) are samples that use Power Automate with one or more Office Scripts as integral parts of the flow.
15+
- [Real-world scenarios](#real-world-scenarios) are a few larger samples framed as complete, real-world solutions.
1516
- [Contributions from the community](#community-contributions-and-fun-samples) are samples from members of the Office Scripts community, often light-hearted in nature.
1617

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

2223
| Project | Details |
2324
|---------|---------|
24-
| [Range samples](range-samples.md) | These samples show how to work the `Range` object, which is central to most scripts. |
25-
| [Table samples](table-samples.md) | A collection of samples that show common interactions with Excel tables.
26-
| [Add comments in Excel](add-excel-comments.md) | This sample adds comments to a cell including @mentioning a colleague. |
27-
| [Add images to a workbook](add-image-to-workbook.md) | This sample adds an image to a workbook and copies an image across sheets.|
28-
| [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. |
29-
| [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. |
30-
| [Create a workbook table of contents](table-of-contents.md) | This sample creates a table of contents with links to each worksheet. |
31-
| [JavaScript `Date` samples](javascript-dates.md) | A collection of samples that show how to translate between JavaScript and Excel date formats. |
32-
| [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. |
25+
| [Ranges: Work with the grid](range-samples.md) | These samples show how to work the `Range` object, which is central to most scripts. |
26+
| [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. |
27+
| [Date samples](javascript-dates.md) | A collection of samples that show how to translate between JavaScript and Excel date formats. |
28+
| [Image samples](add-image-to-workbook.md) | This sample adds an image to a workbook and copies an image across sheets.|
3329
| [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. |
34-
| [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. |
35-
| [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. |
30+
| [Table samples](table-samples.md) | A collection of samples that show common interactions with Excel tables. |
3631

37-
## Beyond the basics
32+
## Quick scenarios
3833

39-
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).
34+
Be sure to download the sample workbooks included with each sample. That lets you skip setup and understand the core concept the sample demonstrates.
4035

4136
| Project | Details |
4237
|---------|---------|
43-
| [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. |
44-
| [Convert CSV files to Excel workbooks](convert-csv.md) | This sample uses Office Scripts and Power Automate to create .xlsx files from .csv files. |
45-
| [Cross-reference workbooks](excel-cross-reference.md) | This sample uses Office Scripts and Power Automate to cross-reference and validate information in different workbooks. |
38+
| [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. |
39+
| [Create a workbook table of contents](table-of-contents.md) | This sample creates a table of contents with links to each worksheet. |
4640
| [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. |
47-
| [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. |
4841
| [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. |
4942
| [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. |
43+
| [Notify people with comments](add-excel-comments.md) | This sample adds comments to a cell including @mentioning a colleague. |
5044
| [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. |
5145
| [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. |
46+
| [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. |
5247
| [Use external fetch calls](external-fetch-calls.md) | This sample uses `fetch` to get information from GitHub for the script. |
53-
| [Write a large dataset](write-large-dataset.md) | This sample shows how to send a large range as smaller subranges. |
5448

55-
## Scenarios
49+
## Cross-application scenarios
50+
51+
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.
52+
53+
| Project | Details |
54+
|---------|---------|
55+
| [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. |
56+
| [Convert CSV files to Excel workbooks](convert-csv.md) | This sample uses Office Scripts and Power Automate to create .xlsx files from .csv files. |
57+
| [Cross-reference workbooks](excel-cross-reference.md) | This sample uses Office Scripts and Power Automate to cross-reference and validate information in different workbooks. |
58+
| [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. |
59+
| [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. |
60+
| [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. |
61+
| [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. |
62+
63+
## Real-world scenarios
5664

5765
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.
5866

docs/toc.yml

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -66,57 +66,59 @@ items:
6666
href: resources/samples/samples-overview.md
6767
- name: Basics
6868
items:
69-
- name: Ranges
69+
- name: 'Ranges: Work with the grid'
7070
href: resources/samples/range-samples.md
71-
- name: Tables
72-
href: resources/samples/table-samples.md
71+
- name: 'Data validation: Dropdown lists, prompts, and warning pop-ups'
72+
href: resources/samples/data-validation-samples.md
7373
- name: Dates
7474
href: resources/samples/javascript-dates.md
75-
- name: Add comments
76-
href: resources/samples/add-excel-comments.md
77-
- name: Add images to a workbook
75+
- name: Images
7876
href: resources/samples/add-image-to-workbook.md
77+
- name: Row and column visibility
78+
href: resources/samples/row-and-column-visibility.md
79+
- name: Tables
80+
href: resources/samples/table-samples.md
81+
- name: Quick scenarios
82+
items:
7983
- name: Copy multiple tables into single table
8084
href: resources/samples/copy-tables-combine.md
81-
- name: "Data validation: dropdown lists, prompts, and warning pop-ups"
82-
href: resources/samples/data-validation-samples.md
8385
- name: Create a workbook table of contents
8486
href: resources/samples/table-of-contents.md
87+
- name: Count blank rows in worksheets
88+
href: resources/samples/count-blank-rows.md
89+
- name: Manage calculation mode
90+
href: resources/samples/excel-calculation.md
91+
- name: Move selected rows across tables
92+
href: resources/samples/move-rows-across-tables.md
93+
- name: Notify people with comments
94+
href: resources/samples/add-excel-comments.md
95+
- name: Output table data as JSON
96+
href: resources/samples/get-table-data.md
97+
- name: Remove hyperlinks from Excel cells
98+
href: resources/samples/remove-hyperlinks-from-cells.md
8599
- name: Remove table column filters
86100
href: resources/samples/clear-table-filter-for-active-cell.md
87-
- name: Report day-to-day changes in Power Automate
88-
href: resources/samples/report-day-to-day-changes.md
89-
- name: Row and column visibility
90-
href: resources/samples/row-and-column-visibility.md
91-
- name: Run a script on all Excel files in a folder
92-
href: resources/samples/automate-tasks-on-all-excel-files-in-folder.md
93101
- name: Set conditional formatting for cross-column comparisons
94102
href: resources/samples/conditional-formatting-parameters.md
95-
- name: Beyond the basics
103+
- name: Use external fetch calls in Office Scripts
104+
href: resources/samples/external-fetch-calls.md
105+
- name: Cross-application scenarios
96106
items:
97107
- name: Combine worksheets into a single workbook
98108
href: resources/samples/combine-worksheets-into-single-workbook.md
99109
- name: Convert CSV files
100110
href: resources/samples/convert-csv.md
101111
- name: Cross-reference worksheets
102112
href: resources/samples/excel-cross-reference.md
103-
- name: Count blank rows in worksheets
104-
href: resources/samples/count-blank-rows.md
105113
- name: Email images of chart and table
106114
href: resources/samples/email-images-chart-table.md
107-
- name: Manage calculation mode
108-
href: resources/samples/excel-calculation.md
109-
- name: Move selected rows across tables
110-
href: resources/samples/move-rows-across-tables.md
111-
- name: Output table data as JSON
112-
href: resources/samples/get-table-data.md
113-
- name: Remove hyperlinks from Excel cells
114-
href: resources/samples/remove-hyperlinks-from-cells.md
115-
- name: Use external fetch calls in Office Scripts
116-
href: resources/samples/external-fetch-calls.md
115+
- name: Report day-to-day changes in Power Automate
116+
href: resources/samples/report-day-to-day-changes.md
117+
- name: Run a script on all Excel files in a folder
118+
href: resources/samples/automate-tasks-on-all-excel-files-in-folder.md
117119
- name: Write a large dataset
118120
href: resources/samples/write-large-dataset.md
119-
- name: Scenarios
121+
- name: Real-world scenarios
120122
items:
121123
- name: Analyze web downloads
122124
href: resources/scenarios/analyze-web-downloads.md

0 commit comments

Comments
 (0)