-
Notifications
You must be signed in to change notification settings - Fork 250
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
Update the W/X quickstart articles when the Dev Kit GA #4902
base: main
Are you sure you want to change the base?
Changes from all commits
4be2d9d
b36a73b
f1761ba
0151746
9468361
4d2e785
074ad23
d540a61
c935e3a
baf9b8c
9349148
f430c6b
2d1bf91
ecc441a
53e225b
dd54fc8
e09e338
d76721e
4f3ef68
f6e6f13
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
- Download and install [Visual Studio Code](https://code.visualstudio.com/). | ||
- Node.js (the latest LTS version). Visit the [Node.js site](https://nodejs.org/) to download and install the right version for your operating system. To verify if you've already installed these tools, run the commands `node -v` and `npm -v` in your terminal. | ||
- Office connected to a Microsoft 365 subscription. You might qualify for a Microsoft 365 E5 developer subscription through the [Microsoft 365 Developer Program](https://developer.microsoft.com/microsoft-365/dev-program), see [FAQ](/office/developer-program/microsoft-365-developer-program-faq#who-qualifies-for-a-microsoft-365-e5-developer-subscription-) for details. Alternatively, you can [sign up for a 1-month free trial](https://www.microsoft.com/microsoft-365/try?rtc=1) or [purchase a Microsoft 365 plan](https://www.microsoft.com/microsoft-365/buy/compare-all-microsoft-365-products). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
1. Open the extension by selecting the Office Add-ins Development Kit icon in the **Activity Bar**. | ||
1. Select **Preview Your Office Add-in (F5)** | ||
1. In the Quick Pick menu, select the option **{Office Host} Desktop (Edge Chromium)**. This will launch the add-in and debug the code. | ||
|
||
The development kit checks that the prerequisites are met before debugging starts. Check the terminal for detailed information if there are issues with your environment. After this process, the Office desktop application launches and sideloads the add-in. Please note that the first time you run a project, it may make take a few minutes to install the dependencies. You will need to install the certificate when prompted. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Once you are finished testing and debugging the add-in, close the add-in by following these steps. | ||
|
||
1. Open the extension by selecting the Office Add-ins Development Kit icon in the **Activity Bar**. | ||
1. Select **Stop Previewing Your Office Add-in**. This closes the web server and removes the add-in from the registry and cache. | ||
1. Close the Office application window at your convenience. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
If you have problems running the add-in, take these steps. | ||
|
||
- Close any open instances of Office. | ||
- Close the previous web server started for the add-in with the **Stop Previewing Your Office Add-in** Office Add-ins Development Kit extension option. | ||
|
||
The article [Troubleshoot development errors with Office Add-ins](../testing/troubleshoot-development-errors.md) contains solutions to common problems. If you're still having issues, [create a GitHub issue](https://aka.ms/officedevkitnewissue) and we'll help you. | ||
|
||
For information on running the add-in on Office on the web, see [Sideload Office Add-ins to Office on the web](../testing/sideload-office-add-ins-for-testing.md). | ||
|
||
For information on debugging on older versions of Office, see [Debug add-ins using developer tools in Microsoft Edge Legacy](../testing/debug-add-ins-using-devtools-edge-legacy.md). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
The add-in project that you've created with the Office Add-ins Development Kit contains sample code for a basic task pane add-in. If you'd like to explore the components of your add-in project, open the project in your code editor and review the files listed below. When you're ready to try out your add-in, proceed to the next section. | ||
|
||
1. The ./manifest.xml or manifest.json file in the root directory of the project defines the settings and capabilities of the add-in. | ||
1. The ./src/taskpane/taskpane.html file contains the HTML markup for the task pane. | ||
1. The ./src/taskpane/taskpane.css file contains the CSS that's applied to content in the task pane. | ||
1. The ./src/taskpane/taskpane.js file contains the Office JavaScript API code that facilitates interaction between the task pane and the Office client application. | ||
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -8,8 +8,47 @@ ms.localizationpriority: high | |||||
|
||||||
# Build an Excel task pane add-in | ||||||
|
||||||
In this article, you'll walk through the process of building an Excel task pane add-in with Yo Office. | ||||||
In this article, you'll walk through the process of building an Excel task pane add-in. You'll use either the Office Add-ins Development Kit or the Yeoman generator to create your Office Add-in. 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. If you'd like to use Visual Studio Code, we recommend the Office Add-ins Development Kit. | ||||||
|
||||||
# [Office Add-ins Development Kit](#tab/devkit) | ||||||
## Prerequisites | ||||||
AlexJerabek marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
[!include[Dev_kit prerequisites](../includes/dev-kit-prerequisites.md)] | ||||||
|
||||||
## Create the add-in project | ||||||
|
||||||
Click the following button to create an add-in project using the Office Add-ins Development Kit for Visual Studio Code. A page that contains the project decription will open in Visual Studio Code. | ||||||
|
||||||
> [!div class="nextstepaction"] | ||||||
> [Create an add-in in Visual Studio Code](vscode://msoffice.microsoft-office-add-in-debugger/open-specific-sample?sample-id=Excel-HelloWorld-TaskPane-JS) | ||||||
|
||||||
In the prompted page, select **Create** to create the add-in project. In the **Workspace folder** dialog that opens, select the folder where you want to create the project. | ||||||
|
||||||
<img src="../images/office-add-ins-development-kit-samplepage-excelquickstart.png" alt="Screenshot shows the sample page in Visual Studio Code"/> | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Favor the Learn image markdown syntax
Suggested change
|
||||||
|
||||||
The Office Add-ins Development Kit will create the project. It will then open the project in a *second* Visual Studio Code window. Close the original Visual Studio Code window. | ||||||
|
||||||
> [!NOTE] | ||||||
> You will receive prompts to install the Office Add-ins Development Kit extension if you haven't. You can also [install the Office Add-ins Development Kit manually](https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @MingjiaLiu1995, looks like this comment was missed. That should resolve the build warnings (which needs to happen before this PR can be checked in) |
||||||
|
||||||
## Explore the project | ||||||
AlexJerabek marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
[!include[Devkit_project_components_taskpane](../includes/devkit-project-components-taskpane.md)] | ||||||
|
||||||
## Try it out | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Try it out", "Stop testing", "Troubleshooting" are same as the ones in (docs/develop/development-kit-overview.md) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same suggestion for an include file. This prevents content from being different in two places if we miss something in an update. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is there a reason we didn't include the headers in the include files? I think you could make this whole thing one include file. |
||||||
|
||||||
[!include[Dev_kit_start_debugging](../includes/dev-kit-start-debugging.md)] | ||||||
|
||||||
## Stop testing your Office Add-in | ||||||
|
||||||
[!include[Dev_kit_stop_debugging](../includes/dev-kit-stop-debugging.md)] | ||||||
|
||||||
## Troubleshooting | ||||||
|
||||||
[!include[Dev_kit_troubleshooting](../includes/dev-kit-troubleshooting.md)] | ||||||
|
||||||
|
||||||
Comment on lines
+49
to
+50
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
# [Yeoman generator](#tab/yeoman) | ||||||
## Prerequisites | ||||||
|
||||||
[!include[Yeoman generator prerequisites](../includes/quickstart-yo-prerequisites.md)] | ||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -8,8 +8,47 @@ ms.localizationpriority: high | |||||
|
||||||
# Build your first Word task pane add-in | ||||||
|
||||||
In this article, you'll walk through the process of building a Word task pane add-in. | ||||||
In this article, you'll walk through the process of building a Word task pane add-in. You'll use either the Office Add-ins Development Kit or the Yeoman generator to create your Office Add-in. 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. If you'd like to use Visual Studio Code, we recommend the Office Add-ins Development Kit. | ||||||
|
||||||
# [Office Add-ins Development Kit](#tab/devkit) | ||||||
## Prerequisites | ||||||
|
||||||
[!include[Dev_kit prerequisites](../includes/dev-kit-prerequisites.md)] | ||||||
|
||||||
## Create the add-in project | ||||||
|
||||||
Click the following button to create an add-in project using the Office Add-ins Development Kit for Visual Studio Code. A page that contains the project decription will open in Visual Studio Code. | ||||||
|
||||||
> [!div class="nextstepaction"] | ||||||
> [Create an add-in in Visual Studio Code](vscode://msoffice.microsoft-office-add-in-debugger/open-specific-sample?sample-id=Excel-HelloWorld-TaskPane-JS) | ||||||
|
||||||
In the prompted page, select **Create** to create the add-in project. In the **Workspace folder** dialog that opens, select the folder where you want to create the project. | ||||||
|
||||||
<img src="../images/office-add-ins-development-kit-samplepage-wordquickstart.png" alt="Screenshot shows the sample page in Visual Studio Code"/> | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
The Office Add-ins Development Kit will create the project. It will then open the project in a *second* Visual Studio Code window. Close the original Visual Studio Code window. | ||||||
|
||||||
> [!NOTE] | ||||||
> You'll be prompted to install the Office Add-ins Development Kit extension if don't already have it. If you need to install the Office Add-ins Development Kit manually, follow [these steps](../development-kit-overview.md?tabs=vscode). | ||||||
|
||||||
## Explore the project | ||||||
|
||||||
[!include[Devkit_project_components_taskpane](../includes/devkit-project-components-taskpane.md)] | ||||||
|
||||||
## Try it out | ||||||
|
||||||
[!include[Dev_kit_start_debugging](../includes/dev-kit-start-debugging.md)] | ||||||
|
||||||
## Stop testing your Office Add-in | ||||||
|
||||||
[!include[Dev_kit_stop_debugging](../includes/dev-kit-stop-debugging.md)] | ||||||
|
||||||
## Troubleshooting | ||||||
|
||||||
[!include[Dev_kit_troubleshooting](../includes/dev-kit-troubleshooting.md)] | ||||||
|
||||||
|
||||||
Comment on lines
+49
to
+50
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
# [Yeoman generator](#tab/yeoman) | ||||||
## Prerequisites | ||||||
|
||||||
[!include[Yeoman generator prerequisites](../includes/quickstart-yo-prerequisites.md)] | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
File names should be in bold