Skip to content
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

[DO NOT MERGE] Enable creating add-in in one step in a new tab #4314

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

GavinGu07
Copy link

This PR is for a new content experiment. We hope to add a new tab in Build your first Word task pane add-in and Build your first Excel task pane add-in pages. The updates are in the screenshots:

image
image
image

This PR should not be merged. Once the experiment succeeds, I'll make updates on the original files.

Copy link
Contributor

Learn Build status updates of commit bcf4f07:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
docs/quickstarts/excel-quickstart-jquery-experiment.md ❌Error Details
docs/quickstarts/word-quickstart-experiment.md ❌Error Details
docs/quickstarts/excel-quickstart-jquery.md ⚠️Warning Details
docs/quickstarts/word-quickstart.md ⚠️Warning Details

docs/quickstarts/excel-quickstart-jquery-experiment.md

  • Line 62, Column 1: [Error: include-not-found] Invalid include link: '../includes/set-up-dev-environment-beforehand.md'.
  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Excel task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/excel-quickstart-jquery.md(2,8), quickstarts/excel-quickstart-jquery-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build an Excel task pane add-in' is duplicated with other articles: 'quickstarts/excel-quickstart-jquery.md(9,1), quickstarts/excel-quickstart-jquery-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Excel task pane add-in by using the Office JS API.' is duplicated in 'quickstarts/excel-quickstart-jquery-experiment.md(3,14)', 'quickstarts/excel-quickstart-jquery.md(3,14)'.

docs/quickstarts/word-quickstart-experiment.md

  • Line 65, Column 1: [Error: include-not-found] Invalid include link: '../includes/set-up-dev-environment-beforehand.md'.
  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Word task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/word-quickstart.md(2,8), quickstarts/word-quickstart-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build your first Word task pane add-in' is duplicated with other articles: 'quickstarts/word-quickstart.md(9,1), quickstarts/word-quickstart-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Word task pane add-in by using the Office JavaScript API.' is duplicated in 'quickstarts/word-quickstart-experiment.md(3,14)', 'quickstarts/word-quickstart.md(3,14)'.

docs/quickstarts/excel-quickstart-jquery.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Excel task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/excel-quickstart-jquery.md(2,8), quickstarts/excel-quickstart-jquery-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build an Excel task pane add-in' is duplicated with other articles: 'quickstarts/excel-quickstart-jquery.md(9,1), quickstarts/excel-quickstart-jquery-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Excel task pane add-in by using the Office JS API.' is duplicated in 'quickstarts/excel-quickstart-jquery-experiment.md(3,14)', 'quickstarts/excel-quickstart-jquery.md(3,14)'.

docs/quickstarts/word-quickstart.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Word task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/word-quickstart.md(2,8), quickstarts/word-quickstart-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build your first Word task pane add-in' is duplicated with other articles: 'quickstarts/word-quickstart.md(9,1), quickstarts/word-quickstart-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Word task pane add-in by using the Office JavaScript API.' is duplicated in 'quickstarts/word-quickstart-experiment.md(3,14)', 'quickstarts/word-quickstart.md(3,14)'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit b8fb09a:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/quickstarts/excel-quickstart-jquery.md ⚠️Warning View Details
docs/quickstarts/excel-quickstart-jquery-experiment.md ⚠️Warning View Details
docs/quickstarts/word-quickstart.md ⚠️Warning View Details
docs/quickstarts/word-quickstart-experiment.md ⚠️Warning View Details
docs/includes/quickstart-choose-editor-experiment.md ✅Succeeded View

docs/quickstarts/excel-quickstart-jquery.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Excel task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/excel-quickstart-jquery.md(2,8), quickstarts/excel-quickstart-jquery-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build an Excel task pane add-in' is duplicated with other articles: 'quickstarts/excel-quickstart-jquery.md(9,1), quickstarts/excel-quickstart-jquery-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Excel task pane add-in by using the Office JS API.' is duplicated in 'quickstarts/excel-quickstart-jquery-experiment.md(3,14)', 'quickstarts/excel-quickstart-jquery.md(3,14)'.

docs/quickstarts/excel-quickstart-jquery-experiment.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Excel task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/excel-quickstart-jquery.md(2,8), quickstarts/excel-quickstart-jquery-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build an Excel task pane add-in' is duplicated with other articles: 'quickstarts/excel-quickstart-jquery.md(9,1), quickstarts/excel-quickstart-jquery-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Excel task pane add-in by using the Office JS API.' is duplicated in 'quickstarts/excel-quickstart-jquery-experiment.md(3,14)', 'quickstarts/excel-quickstart-jquery.md(3,14)'.

docs/quickstarts/word-quickstart.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Word task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/word-quickstart.md(2,8), quickstarts/word-quickstart-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build your first Word task pane add-in' is duplicated with other articles: 'quickstarts/word-quickstart.md(9,1), quickstarts/word-quickstart-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Word task pane add-in by using the Office JavaScript API.' is duplicated in 'quickstarts/word-quickstart-experiment.md(3,14)', 'quickstarts/word-quickstart.md(3,14)'.

docs/quickstarts/word-quickstart-experiment.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Word task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/word-quickstart.md(2,8), quickstarts/word-quickstart-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build your first Word task pane add-in' is duplicated with other articles: 'quickstarts/word-quickstart.md(9,1), quickstarts/word-quickstart-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Word task pane add-in by using the Office JavaScript API.' is duplicated in 'quickstarts/word-quickstart-experiment.md(3,14)', 'quickstarts/word-quickstart.md(3,14)'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@samantharamon samantharamon self-assigned this Dec 12, 2023
Copy link
Contributor

Learn Build status updates of commit 5b361ee:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/quickstarts/excel-quickstart-jquery.md ⚠️Warning View Details
docs/quickstarts/excel-quickstart-jquery-experiment.md ⚠️Warning View Details
docs/quickstarts/word-quickstart.md ⚠️Warning View Details
docs/quickstarts/word-quickstart-experiment.md ⚠️Warning View Details
docs/includes/quickstart-choose-editor-experiment.md ✅Succeeded View

docs/quickstarts/excel-quickstart-jquery.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Excel task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/excel-quickstart-jquery.md(2,8), quickstarts/excel-quickstart-jquery-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build an Excel task pane add-in' is duplicated with other articles: 'quickstarts/excel-quickstart-jquery.md(9,1), quickstarts/excel-quickstart-jquery-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Excel task pane add-in by using the Office JS API.' is duplicated in 'quickstarts/excel-quickstart-jquery-experiment.md(3,14)', 'quickstarts/excel-quickstart-jquery.md(3,14)'.

docs/quickstarts/excel-quickstart-jquery-experiment.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Excel task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/excel-quickstart-jquery.md(2,8), quickstarts/excel-quickstart-jquery-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build an Excel task pane add-in' is duplicated with other articles: 'quickstarts/excel-quickstart-jquery.md(9,1), quickstarts/excel-quickstart-jquery-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Excel task pane add-in by using the Office JS API.' is duplicated in 'quickstarts/excel-quickstart-jquery-experiment.md(3,14)', 'quickstarts/excel-quickstart-jquery.md(3,14)'.

docs/quickstarts/word-quickstart.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Word task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/word-quickstart.md(2,8), quickstarts/word-quickstart-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build your first Word task pane add-in' is duplicated with other articles: 'quickstarts/word-quickstart.md(9,1), quickstarts/word-quickstart-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Word task pane add-in by using the Office JavaScript API.' is duplicated in 'quickstarts/word-quickstart-experiment.md(3,14)', 'quickstarts/word-quickstart.md(3,14)'.

docs/quickstarts/word-quickstart-experiment.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Word task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/word-quickstart.md(2,8), quickstarts/word-quickstart-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build your first Word task pane add-in' is duplicated with other articles: 'quickstarts/word-quickstart.md(9,1), quickstarts/word-quickstart-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Word task pane add-in by using the Office JavaScript API.' is duplicated in 'quickstarts/word-quickstart-experiment.md(3,14)', 'quickstarts/word-quickstart.md(3,14)'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@@ -0,0 +1 @@
You can create an Office Add-in by using the one-line script, or Yeoman generator for Office Add-ins, or Visual Studio. The one-line script automatically sets up your local machine and launches Visual Studio Code with sample project, and the Yeoman generator creates a Node.js project that can be managed with Visual Studio Code or any other editor, whereas Visual Studio creates a Visual Studio solution. Select the tab for the one you'd like to use and then follow the instructions to create your add-in and test it locally.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can create an Office Add-in by using the one-line script, or Yeoman generator for Office Add-ins, or Visual Studio. The one-line script automatically sets up your local machine and launches Visual Studio Code with sample project, and the Yeoman generator creates a Node.js project that can be managed with Visual Studio Code or any other editor, whereas Visual Studio creates a Visual Studio solution. Select the tab for the one you'd like to use and then follow the instructions to create your add-in and test it locally.
Create an Office add-in using the one-line script, Yeoman generator for Office Add-ins, or Visual Studio.
- The one-line script automatically sets up your local machine's environment and launches the sample add-in project in Visual Studio Code. This bypasses the manual steps to build an add-in and takes you straight to the code, so that you can test the add-in immediately.
- The Yeoman generator creates a Node.js project that can be managed with Visual Studio Code or any other editor.
- Visual Studio creates a Visual Studio solution.
Select the tab for the option you'd like to use, then follow the instructions to create your add-in and test it locally.


[!include[Choose your editor](../includes/quickstart-choose-editor-experiment.md)]

# [Create add-in in one step!](#tab/onelinescript)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# [Create add-in in one step!](#tab/onelinescript)
# [One-line script](#tab/script)

To be consistent with the naming of the tooling tabs. However, I did add the single step messaging in the includes file.


### Prerequisites

Microsoft 365.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Microsoft 365.
You must have Office connected to a Microsoft 365 subscription.

### Prerequisites

Microsoft 365.
You can sign up for the [Microsoft 365 Developer Program](https://developer.microsoft.com/microsoft-365/dev-program) to get a free Microsoft 365 subscription.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can sign up for the [Microsoft 365 Developer Program](https://developer.microsoft.com/microsoft-365/dev-program) to get a free Microsoft 365 subscription.
> [!NOTE]
> If you don't already have Office, you can [join the Microsoft 365 developer program](https://developer.microsoft.com/microsoft-365/dev-program) to get a free, 90-day renewable Microsoft 365 subscription to use during development.

For consistency with other tabs.

Comment on lines 19 to 20
If you like to skip step-by-step instructions and directly run the sample and view its code, simply run below command.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you like to skip step-by-step instructions and directly run the sample and view its code, simply run below command.

Moved this to the previous paragraph (includes file), so that the user can jump straight into what needs to be done.

```command line
iwr aka.ms/wordaddin/helloworld -o wordhelloworld.bat; saps wordhelloworld.bat 
```
For MacOS:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For MacOS:
If you're using macOS, run the following in a terminal.

Comment on lines 36 to 44

This script works in Windows or MacOS, and it will automatically execute all the required steps for running the sample and opening the code for viewing and editing. The steps include:

- Install Node.js, npm, git if they are not found on your machine.
- Download sample project.
- Launch Visual Studio Code (or launch sample project directory if you don’t have VS Code installed).
- Run the sample automatically if you choose so.

Stay tuned for expanded platform support on this command.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This script works in Windows or MacOS, and it will automatically execute all the required steps for running the sample and opening the code for viewing and editing. The steps include:
- Install Node.js, npm, git if they are not found on your machine.
- Download sample project.
- Launch Visual Studio Code (or launch sample project directory if you don’t have VS Code installed).
- Run the sample automatically if you choose so.
Stay tuned for expanded platform support on this command.

Moved above commands.


Stay tuned for expanded platform support on this command.

### Expected results
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Expected results
### Try it out

Comment on lines 48 to 50
Visual Studio Code with sample code automatically opens, if you don’t have VS Code installed the sample project directory will be launched.

If you choose to launch sample when prompted, a Word document with add-in task pane automatically opens, and at the bottom of the task pane, choose the Run link to add the text "Hello World" to the document in blue font.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Visual Studio Code with sample code automatically opens, if you dont have VS Code installed the sample project directory will be launched.
If you choose to launch sample when prompted, a Word document with add-in task pane automatically opens, and at the bottom of the task pane, choose the Run link to add the text "Hello World" to the document in blue font.
Once your add-in project is set up, it automatically opens in Visual Studio Code. If you don't have Visual Studio Code installed on your machine, the folder containing the files of your add-in project opens instead.
If you choose to run the add-in when prompted, an Excel spreadsheet opens, displaying the add-in task pane. Select a range of cells in the spreadsheet, then choose **Run** from the task pane to set the color of the selected range to yellow.


If you choose to launch sample when prompted, a Word document with add-in task pane automatically opens, and at the bottom of the task pane, choose the Run link to add the text "Hello World" to the document in blue font.

![The Word application with the task pane add-in loaded.](../images/word-quickstart-addin-1c.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
![The Word application with the task pane add-in loaded.](../images/word-quickstart-addin-1c.png)
![The sample add-in task pane in Word with the Run button highlighted.](../images/word-quickstart-addin-1c.png)

Copy link
Contributor

Learn Build status updates of commit 32cb3ef:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/quickstarts/excel-quickstart-jquery.md ⚠️Warning View Details
docs/quickstarts/excel-quickstart-jquery-experiment.md ⚠️Warning View Details
docs/quickstarts/word-quickstart.md ⚠️Warning View Details
docs/quickstarts/word-quickstart-experiment.md ⚠️Warning View Details
docs/includes/quickstart-choose-editor-experiment.md ✅Succeeded View

docs/quickstarts/excel-quickstart-jquery.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Excel task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/excel-quickstart-jquery.md(2,8), quickstarts/excel-quickstart-jquery-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build an Excel task pane add-in' is duplicated with other articles: 'quickstarts/excel-quickstart-jquery.md(9,1), quickstarts/excel-quickstart-jquery-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Excel task pane add-in by using the Office JS API.' is duplicated in 'quickstarts/excel-quickstart-jquery-experiment.md(3,14)', 'quickstarts/excel-quickstart-jquery.md(3,14)'.

docs/quickstarts/excel-quickstart-jquery-experiment.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Excel task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/excel-quickstart-jquery.md(2,8), quickstarts/excel-quickstart-jquery-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build an Excel task pane add-in' is duplicated with other articles: 'quickstarts/excel-quickstart-jquery.md(9,1), quickstarts/excel-quickstart-jquery-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Excel task pane add-in by using the Office JS API.' is duplicated in 'quickstarts/excel-quickstart-jquery-experiment.md(3,14)', 'quickstarts/excel-quickstart-jquery.md(3,14)'.

docs/quickstarts/word-quickstart.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Word task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/word-quickstart.md(2,8), quickstarts/word-quickstart-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build your first Word task pane add-in' is duplicated with other articles: 'quickstarts/word-quickstart.md(9,1), quickstarts/word-quickstart-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Word task pane add-in by using the Office JavaScript API.' is duplicated in 'quickstarts/word-quickstart-experiment.md(3,14)', 'quickstarts/word-quickstart.md(3,14)'.

docs/quickstarts/word-quickstart-experiment.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Word task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/word-quickstart.md(2,8), quickstarts/word-quickstart-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build your first Word task pane add-in' is duplicated with other articles: 'quickstarts/word-quickstart.md(9,1), quickstarts/word-quickstart-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Word task pane add-in by using the Office JavaScript API.' is duplicated in 'quickstarts/word-quickstart-experiment.md(3,14)', 'quickstarts/word-quickstart.md(3,14)'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:


Once your add-in project is set up, it automatically opens in Visual Studio Code. If you don't have Visual Studio Code installed on your machine, the folder containing the files of your add-in project opens instead.

If you choose to run the add-in when prompted, an Excel spreadsheet opens, displaying the add-in task pane. Select a range of cells in the spreadsheet, then choose **Run** from the task pane to set the color of the selected range to yellow.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you choose to run the add-in when prompted, an Excel spreadsheet opens, displaying the add-in task pane. Select a range of cells in the spreadsheet, then choose **Run** from the task pane to set the color of the selected range to yellow.
If you choose to run the add-in when prompted, a Word document opens, displaying the add-in task pane. Select **Run** from the task pane to add the text "Hello World" to the document in the color blue.


### Try it out

Once your add-in project is set up, it automatically opens in Visual Studio Code. If you don't have Visual Studio Code installed on your machine, the folder containing the files of your add-in project opens instead.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once your add-in project is set up, it automatically opens in Visual Studio Code. If you don't have Visual Studio Code installed on your machine, the folder containing the files of your add-in project opens instead.
Once your add-in project is set up, it automatically opens in Visual Studio Code.
> [!NOTE]
> If you don't have Visual Studio Code installed on your machine, the folder containing the files of your add-in project opens instead. For guidance on how to install Visual Studio Code and test the add-in, see the project's readme file.


### Try it out

Once your add-in project is set up, it automatically opens in Visual Studio Code. If you don't have Visual Studio Code installed on your machine, the folder containing the files of your add-in project opens instead.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once your add-in project is set up, it automatically opens in Visual Studio Code. If you don't have Visual Studio Code installed on your machine, the folder containing the files of your add-in project opens instead.
Once your add-in project is set up, it automatically opens in Visual Studio Code.
> [!NOTE]
> If you don't have Visual Studio Code installed on your machine, the folder containing the files of your add-in project opens instead. For guidance on how to install Visual Studio Code and test the add-in, see the project's readme file.

@GavinGu07 suggesting this to provide additional guidance for users without VS Code installed. I took this from the spec, but let me know if this is no longer accurate.

Copy link
Contributor

Learn Build status updates of commit d87be2f:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/quickstarts/excel-quickstart-jquery.md ⚠️Warning View Details
docs/quickstarts/excel-quickstart-jquery-experiment.md ⚠️Warning View Details
docs/quickstarts/word-quickstart.md ⚠️Warning View Details
docs/quickstarts/word-quickstart-experiment.md ⚠️Warning View Details
docs/includes/quickstart-choose-editor-experiment.md ✅Succeeded View

docs/quickstarts/excel-quickstart-jquery.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Excel task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/excel-quickstart-jquery.md(2,8), quickstarts/excel-quickstart-jquery-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build an Excel task pane add-in' is duplicated with other articles: 'quickstarts/excel-quickstart-jquery.md(9,1), quickstarts/excel-quickstart-jquery-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Excel task pane add-in by using the Office JS API.' is duplicated in 'quickstarts/excel-quickstart-jquery-experiment.md(3,14)', 'quickstarts/excel-quickstart-jquery.md(3,14)'.

docs/quickstarts/excel-quickstart-jquery-experiment.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Excel task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/excel-quickstart-jquery.md(2,8), quickstarts/excel-quickstart-jquery-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build an Excel task pane add-in' is duplicated with other articles: 'quickstarts/excel-quickstart-jquery.md(9,1), quickstarts/excel-quickstart-jquery-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Excel task pane add-in by using the Office JS API.' is duplicated in 'quickstarts/excel-quickstart-jquery-experiment.md(3,14)', 'quickstarts/excel-quickstart-jquery.md(3,14)'.

docs/quickstarts/word-quickstart.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Word task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/word-quickstart.md(2,8), quickstarts/word-quickstart-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build your first Word task pane add-in' is duplicated with other articles: 'quickstarts/word-quickstart.md(9,1), quickstarts/word-quickstart-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Word task pane add-in by using the Office JavaScript API.' is duplicated in 'quickstarts/word-quickstart-experiment.md(3,14)', 'quickstarts/word-quickstart.md(3,14)'.

docs/quickstarts/word-quickstart-experiment.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Build your first Word task pane add-in - Office Add-ins' is duplicated in: 'quickstarts/word-quickstart.md(2,8), quickstarts/word-quickstart-experiment.md(2,8)'. Titles must be unique within a docset.
  • Line 9, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Build your first Word task pane add-in' is duplicated with other articles: 'quickstarts/word-quickstart.md(9,1), quickstarts/word-quickstart-experiment.md(9,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to build a simple Word task pane add-in by using the Office JavaScript API.' is duplicated in 'quickstarts/word-quickstart-experiment.md(3,14)', 'quickstarts/word-quickstart.md(3,14)'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

- The one-line script automatically sets up your local machine's environment and launches the sample add-in project in Visual Studio Code. This bypasses the manual steps to build an add-in and takes you straight to the code, so that you can test the add-in immediately.
- The Yeoman generator creates a Node.js project that can be managed with Visual Studio Code or any other editor.
- Visual Studio creates a Visual Studio solution.
Select the tab for the option you'd like to use, then follow the instructions to create your add-in and test it locally.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Select the tab for the option you'd like to use, then follow the instructions to create your add-in and test it locally.
Select the tab for the option you'd like to use, then follow the instructions to create your add-in and test it locally.

You can run the one-line script on Windows or on macOS. It performs the following to set up the add-in development environment.

On Windows:
- Installs Node.js, and Git, if they aren't found on your machine.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Installs Node.js, and Git, if they aren't found on your machine.
- Installs Node.js and Git, if they aren't found on your machine.

- Downloads the files of the sample add-in project.
- Opens the folder that contains the add-in project files. Or opens the add-in project in Visual Studio Code if it is installed and configured to support launching from terminal.
- Prompts you to run the add-in.
> [!NOTE]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> [!NOTE]
> [!NOTE]


On macOS:
- Downloads the files of the sample add-in project.
- Opens the folder that contains the add-in project files. Or opens the add-in project in Visual Studio Code if it is installed and configured to support launching from terminal.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Opens the folder that contains the add-in project files. Or opens the add-in project in Visual Studio Code if it is installed and configured to support launching from terminal.
- Opens the folder that contains the add-in project files. If Visual Studio Code is installed and configured to launch projects from the terminal, the add-in project opens there instead.


Once your add-in project is set up, it automatically opens in Visual Studio Code. If you don't have Visual Studio Code installed on your machine, the folder containing the files of your add-in project opens instead.

If you choose to run the add-in when prompted, a Word document opens, displaying the add-in task pane. choose the **Run** link to add the text "Hello World" to the document in blue font.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you choose to run the add-in when prompted, a Word document opens, displaying the add-in task pane. choose the **Run** link to add the text "Hello World" to the document in blue font.
If you choose to run the add-in when prompted, a Word document opens, displaying the add-in task pane. From the task pane, select **Run** to add the text "Hello World" to the document in blue font.

You can run the one-line script on Windows or on macOS. It performs the following to set up the add-in development environment.

On Windows:
- Installs Node.js, and Git, if they aren't found on your machine.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Installs Node.js, and Git, if they aren't found on your machine.
- Installs Node.js and Git, if they aren't found on your machine.


On macOS:
- Downloads the files of the sample add-in project.
- Opens the folder that contains the add-in project files. Or opens the add-in project in Visual Studio Code if it is installed and configured to support launching from terminal.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Opens the folder that contains the add-in project files. Or opens the add-in project in Visual Studio Code if it is installed and configured to support launching from terminal.
- Opens the folder that contains the add-in project files. If Visual Studio Code is installed and configured to launch projects from the terminal, the add-in project opens there instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants