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

refactor: office xml addin string and readme #11082

Merged
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
22 changes: 11 additions & 11 deletions packages/fx-core/resource/package.nls.json
Original file line number Diff line number Diff line change
Expand Up @@ -375,36 +375,36 @@
"core.createProjectQuestion.officeXMLAddin.bar.detail": "Creating Project.",
"core.createProjectQuestion.officeXMLAddin.mainEntry.title": "Office Add-in",
"core.createProjectQuestion.officeXMLAddin.mainEntry.detail": "Create integration with Outlook, Word, Excel, or PowerPoint",
"core.createProjectQuestion.officeXMLAddin.create.title": "Select to create an Outlook, Word, Excel, or PowerPoint Add-in",
"core.createProjectQuestion.officeXMLAddin.create.title": "Select to Create an Outlook, Word, Excel, or PowerPoint Add-in",
"core.createProjectQuestion.officeXMLAddin.word.title": "Word Add-in",
"core.createProjectQuestion.officeXMLAddin.word.detail": "Create an add-in that can run in Word across multiple platforms",
"core.createProjectQuestion.officeXMLAddin.word.sso.title": "Add-in with Single Sign On",
"core.createProjectQuestion.officeXMLAddin.word.sso.detail": "Create a Word add-in with Single Sign On capabilities",
"core.createProjectQuestion.officeXMLAddin.word.react.title": "Add-in with React framework",
"core.createProjectQuestion.officeXMLAddin.word.react.title": "Add-in with React Framework",
"core.createProjectQuestion.officeXMLAddin.word.react.detail": "Create a Word add-in with React framework",
"core.createProjectQuestion.officeXMLAddin.word.create.title": "Create a Word Add-in",
"core.createProjectQuestion.officeXMLAddin.excel.title": "Excel Add-in",
"core.createProjectQuestion.officeXMLAddin.excel.detail": "Extend Excel functionality and access Excel data on multiple platforms",
"core.createProjectQuestion.officeXMLAddin.excel.sso.title": "Add-in with Single Sign On",
"core.createProjectQuestion.officeXMLAddin.excel.sso.detail": "Create an Excel add-in with Single Sign On capabilities",
"core.createProjectQuestion.officeXMLAddin.excel.react.title": "Add-in with React framework",
"core.createProjectQuestion.officeXMLAddin.excel.react.title": "Add-in with React Framework",
"core.createProjectQuestion.officeXMLAddin.excel.react.detail": "Create an Excel add-in with React framework",
"core.createProjectQuestion.officeXMLAddin.excel.cf.shared.title": "Excel Custom Functions using a Shared Runtime",
"core.createProjectQuestion.officeXMLAddin.excel.cf.shared.title": "Excel Custom Functions Using a Shared Runtime",
"core.createProjectQuestion.officeXMLAddin.excel.cf.shared.detail": "Create an Excel add-in leveraging Custom Functions using a Shared Runtime",
"core.createProjectQuestion.officeXMLAddin.excel.cf.js.title": "Excel Custom Functions using a JavaScript-only Runtime",
"core.createProjectQuestion.officeXMLAddin.excel.cf.js.title": "Excel Custom Functions Using a JavaScript-only Runtime",
"core.createProjectQuestion.officeXMLAddin.excel.cf.js.detail": "Create an Excel add-in leveraging Custom Functions using a JavaScript-only Runtime",
"core.createProjectQuestion.officeXMLAddin.excel.create.title": "Create an Excel Add-in",
"core.createProjectQuestion.officeXMLAddin.powerpoint.title": "PowerPoint Add-in",
"core.createProjectQuestion.officeXMLAddin.powerpoint.detail": "Build engaging solutions for presentations across platform",
"core.createProjectQuestion.officeXMLAddin.powerpoint.sso.title": "Create a PowerPoint add-in with Single Sign On capabilities",
"core.createProjectQuestion.officeXMLAddin.powerpoint.sso.title": "Add-in with Single Sign On",
"core.createProjectQuestion.officeXMLAddin.powerpoint.sso.detail": "PowerPoint add-in with Single Sign On capabilities",
"core.createProjectQuestion.officeXMLAddin.powerpoint.react.title": "Add-in with React framework",
"core.createProjectQuestion.officeXMLAddin.powerpoint.react.title": "Add-in with React Framework",
"core.createProjectQuestion.officeXMLAddin.powerpoint.react.detail": "Create a PowerPoint add-in with React framework",
"core.createProjectQuestion.officeXMLAddin.powerpoint.create.title": "Create a PowerPoint Add-in",
"core.createProjectQuestion.officeXMLAddin.taskpane.title": "Add-in with Basic Taskpane",
"core.createProjectQuestion.officeXMLAddin.taskpane.detail": "Customize the Ribbon with a button and embed content in the Taskpane",
"core.createProjectQuestion.officeXMLAddin.manifestOnly.title": "Add-in project containing the manifest only",
"core.createProjectQuestion.officeXMLAddin.manifestOnly.detail": "Create a simple add-in project with a manifest file only",
"core.createProjectQuestion.officeXMLAddin.taskpane.title": "Add-in with Basic Task Pane",
"core.createProjectQuestion.officeXMLAddin.taskpane.detail": "Customize the Ribbon with a button and create a dashboard in the Task Pane",
"core.createProjectQuestion.officeXMLAddin.manifestOnly.title": "Add-in Project With only Manifest File",
"core.createProjectQuestion.officeXMLAddin.manifestOnly.detail": "Create an add-in project that includes only the manifest file",
"core.aiAssistantBotOption.label": "AI Assistant Bot",
"core.aiAssistantBotOption.detail": "A custom AI assistant bot in Teams using Teams AI library and OpenAI Assistants API",
"core.aiBotOption.label": "AI Chat Bot",
Expand Down
2 changes: 1 addition & 1 deletion packages/fx-core/src/question/create.ts
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ export class ProjectTypeOptions {
static officeXMLAddin(platform?: Platform): OptionItem {
return {
id: "office-xml-addin-type",
label: `${platform === Platform.VSCode ? "$(inbox) " : ""}${getLocalizedString(
label: `${platform === Platform.VSCode ? "$(teamsfx-m365) " : ""}${getLocalizedString(
"core.createProjectQuestion.officeXMLAddin.mainEntry.title"
)}`,
detail: getLocalizedString("core.createProjectQuestion.officeXMLAddin.mainEntry.detail"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export interface CreateProjectInputs extends Inputs {
runtime?: "node" | "dotnet";
/** @description New Project */
"project-type"?: "bot-type" | "tab-type" | "me-type" | "outlook-addin-type" | "office-addin-type";
/** @description Select to create an Outlook, Word, Excel, or PowerPoint Add-in */
/** @description Select to Create an Outlook, Word, Excel, or PowerPoint Add-in */
"addin-host"?: "outlook" | "word" | "excel" | "powerpoint";
/** @description Capabilities */
capabilities?:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export const CreateProjectOptions: CLICommandOption[] = [
{
name: "addin-host",
type: "string",
description: "Select to create an Outlook, Word, Excel, or PowerPoint Add-in",
description: "Select to Create an Outlook, Word, Excel, or PowerPoint Add-in",
choices: ["outlook", "word", "excel", "powerpoint"],
},
{
Expand Down
17 changes: 6 additions & 11 deletions templates/js/office-xml-addin-excel-cf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,14 @@ You can use this repository as a sample to base your own custom functions projec

## Run and Debug Excel Add-in

Before run and start the debug, make sure that:
1. Close all opened Office Application windows.
2. Click the *`Check and Install Dependencies`* in Teams Toolkit extension sidebar.

You can run and debug this project by either of the following ways:

- By hitting the `F5` key in Visual Studio Code.
- By clicking the *`Preview Your Add-in`* in Teams Toolkit extension side bar.
- By clicking the *`Preview Your Add-in`* in Teams Toolkit extension sidebar.
- By running with command `npm run start` in the terminal.

## Debugging custom functions
Expand All @@ -35,20 +39,11 @@ The add-in project that you've created contains sample code for a basic task pan
- The `./src/taskpane/taskpane.css` file contains the CSS that's applied to content in the task pane.
- The `./src/taskpane/taskpane.js` file contains the Office JavaScript API code that facilitates interaction between the task pane and the Excel application.


## Edit the manifest

You can edit the manifest file by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Edit Manifest`*.
- Directly edit and modify the content in `./manifest.xml`.


## Validate manifest

You can check whether your manifest file is valid by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Validate Manifest`*.
- From Visual Studio Code: open Teams Toolkit extension sidebar and click *`Validate Manifest`*.
- From Terminal: run the command `npx --yes office-addin-manifest validate manifest.xml`

## Additional resources
Expand Down
11 changes: 1 addition & 10 deletions templates/js/office-xml-addin-excel-manifest-only/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,9 @@ The add-in project that you've created contains sample code for a basic task pan

- The `./manifest.xml` file in the root directory of the project defines the settings and capabilities of the add-in.


## Edit the manifest

You can edit the manifest file by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Edit Manifest`*.
- Directly edit and modify the content in `./manifest.xml`.


## Validate manifest

You can check whether your manifest file is valid by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Validate Manifest`*.
- From Visual Studio Code: open Teams Toolkit extension sidebar and click *`Validate Manifest`*.
- From Terminal: run the command `npx --yes office-addin-manifest validate manifest.xml`
17 changes: 6 additions & 11 deletions templates/js/office-xml-addin-excel-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,14 @@ Excel add-ins are integrations built by third parties into Excel by using [Excel

## Run and Debug Excel Add-in

Before run and start the debug, make sure that:
1. Close all opened Office Application windows.
2. Click the *`Check and Install Dependencies`* in Teams Toolkit extension sidebar.

You can run and debug this project by either of the following ways:

- By hitting the `F5` key in Visual Studio Code.
- By clicking the *`Preview Your Add-in`* in Teams Toolkit extension side bar.
- By clicking the *`Preview Your Add-in`* in Teams Toolkit extension sidebar.
- By running with command `npm run start` in the terminal.


Expand All @@ -24,18 +28,9 @@ The add-in project that you've created contains sample code for a basic task pan
- The `./src/taskpane/taskpane.html` file contains the HTML markup for the task pane.
- The `./src/taskpane/**/*.jsx` file contains the react code and Office JavaScript API code that facilitates interaction between the task pane and the Excel application.


## Edit the manifest

You can edit the manifest file by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Edit Manifest`*.
- Directly edit and modify the content in `./manifest.xml`.


## Validate manifest

You can check whether your manifest file is valid by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Validate Manifest`*.
- From Visual Studio Code: open Teams Toolkit extension sidebar and click *`Validate Manifest`*.
- From Terminal: run the command `npx --yes office-addin-manifest validate manifest.xml`
17 changes: 6 additions & 11 deletions templates/js/office-xml-addin-excel-sso/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ Excel add-ins are integrations built by third parties into Excel by using [Excel

## Instructions

Before run and start the debug, make sure that:
1. Close all opened Office Application windows.
2. Click the *`Check and Install Dependencies`* in Teams Toolkit extension sidebar.

- Run the following command to configure single-sign on for your add-in project.

```shell
Expand All @@ -19,7 +23,7 @@ npm run configure-sso

- Build the project, start the local web server, and side-load your add-in in the previously selected Office client application by either of the following ways:
- By hitting the `F5` key in Visual Studio Code.
- By clicking the *`Preview Your Add-in`* in Teams Toolkit extension side bar.
- By clicking the *`Preview Your Add-in`* in Teams Toolkit extension sidebar.
- By running with command `npm run start` in the terminal.

> [!NOTE]
Expand All @@ -44,18 +48,9 @@ The add-in project that you've created contains sample code for a basic task pan
- The `./src/taskpane/taskpane.css` file contains the CSS that's applied to content in the task pane.
- The `./src/taskpane/taskpane.js` file contains the Office JavaScript API code that facilitates interaction between the task pane and the Excel application.


## Edit the manifest

You can edit the manifest file by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Edit Manifest`*.
- Directly edit and modify the content in `./manifest.xml`.


## Validate manifest

You can check whether your manifest file is valid by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Validate Manifest`*.
- From Visual Studio Code: open Teams Toolkit extension sidebar and click *`Validate Manifest`*.
- From Terminal: run the command `npx --yes office-addin-manifest validate manifest.xml`
17 changes: 6 additions & 11 deletions templates/js/office-xml-addin-excel-taskpane/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,14 @@ Excel add-ins are integrations built by third parties into Excel by using [Excel

## Run and Debug Excel Add-in

Before run and start the debug, make sure that:
1. Close all opened Office Application windows.
2. Click the *`Check and Install Dependencies`* in Teams Toolkit extension sidebar.

You can run and debug this project by either of the following ways:

- By hitting the `F5` key in Visual Studio Code.
- By clicking the *`Preview Your Add-in`* in Teams Toolkit extension side bar.
- By clicking the *`Preview Your Add-in`* in Teams Toolkit extension sidebar.
- By running with command `npm run start` in the terminal.


Expand All @@ -25,18 +29,9 @@ The add-in project that you've created contains sample code for a basic task pan
- The `./src/taskpane/taskpane.css` file contains the CSS that's applied to content in the task pane.
- The `./src/taskpane/taskpane.js` file contains the Office JavaScript API code that facilitates interaction between the task pane and the Excel application.


## Edit the manifest

You can edit the manifest file by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Edit Manifest`*.
- Directly edit and modify the content in `./manifest.xml`.


## Validate manifest

You can check whether your manifest file is valid by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Validate Manifest`*.
- From Visual Studio Code: open Teams Toolkit extension sidebar and click *`Validate Manifest`*.
- From Terminal: run the command `npx --yes office-addin-manifest validate manifest.xml`
11 changes: 1 addition & 10 deletions templates/js/office-xml-addin-powerpoint-manifest-only/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,9 @@ The add-in project that you've created contains sample code for a basic task pan

- The `./manifest.xml` file in the root directory of the project defines the settings and capabilities of the add-in.


## Edit the manifest

You can edit the manifest file by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Edit Manifest`*.
- Directly edit and modify the content in `./manifest.xml`.


## Validate manifest

You can check whether your manifest file is valid by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Validate Manifest`*.
- From Visual Studio Code: open Teams Toolkit extension sidebar and click *`Validate Manifest`*.
- From Terminal: run the command `npx --yes office-addin-manifest validate manifest.xml`
17 changes: 6 additions & 11 deletions templates/js/office-xml-addin-powerpoint-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,14 @@ PowerPoint add-ins are integrations built by third parties into PowerPoint by us

## Run and Debug PowerPoint Add-in

Before run and start the debug, make sure that:
1. Close all opened Office Application windows.
2. Click the *`Check and Install Dependencies`* in Teams Toolkit extension sidebar.

You can run and debug this project by either of the following ways:

- By hitting the `F5` key in Visual Studio Code.
- By clicking the *`Preview Your Add-in`* in Teams Toolkit extension side bar.
- By clicking the *`Preview Your Add-in`* in Teams Toolkit extension sidebar.
- By running with command `npm run start` in the terminal.


Expand All @@ -24,18 +28,9 @@ The add-in project that you've created contains sample code for a basic task pan
- The `./src/taskpane/taskpane.html` file contains the HTML markup for the task pane.
- The `./src/taskpane/**/*.jsx` file contains the react code and Office JavaScript API code that facilitates interaction between the task pane and the PowerPoint application.


## Edit the manifest

You can edit the manifest file by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Edit Manifest`*.
- Directly edit and modify the content in `./manifest.xml`.


## Validate manifest

You can check whether your manifest file is valid by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Validate Manifest`*.
- From Visual Studio Code: open Teams Toolkit extension sidebar and click *`Validate Manifest`*.
- From Terminal: run the command `npx --yes office-addin-manifest validate manifest.xml`
17 changes: 6 additions & 11 deletions templates/js/office-xml-addin-powerpoint-sso/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ PowerPoint add-ins are integrations built by third parties into PowerPoint by us

## Instructions

Before run and start the debug, make sure that:
1. Close all opened Office Application windows.
2. Click the *`Check and Install Dependencies`* in Teams Toolkit extension sidebar.

- Run the following command to configure single-sign on for your add-in project.

```shell
Expand All @@ -19,7 +23,7 @@ npm run configure-sso

- Build the project, start the local web server, and side-load your add-in in the previously selected Office client application by either of the following ways:
- By hitting the `F5` key in Visual Studio Code.
- By clicking the *`Preview Your Add-in`* in Teams Toolkit extension side bar.
- By clicking the *`Preview Your Add-in`* in Teams Toolkit extension sidebar.
- By running with command `npm run start` in the terminal.

> [!NOTE]
Expand All @@ -44,18 +48,9 @@ The add-in project that you've created contains sample code for a basic task pan
- The `./src/taskpane/taskpane.css` file contains the CSS that's applied to content in the task pane.
- The `./src/taskpane/taskpane.js` file contains the Office JavaScript API code that facilitates interaction between the task pane and the PowerPoint application.


## Edit the manifest

You can edit the manifest file by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Edit Manifest`*.
- Directly edit and modify the content in `./manifest.xml`.


## Validate manifest

You can check whether your manifest file is valid by either of the following ways:

- From Visual Studio Code: open Teams Toolkit extension side bar and click *`Validate Manifest`*.
- From Visual Studio Code: open Teams Toolkit extension sidebar and click *`Validate Manifest`*.
- From Terminal: run the command `npx --yes office-addin-manifest validate manifest.xml`
Loading
Loading