Skip to content

[Word] (citation mgmt) Add unified manifest support #967

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Jul 8, 2025

Conversation

ElizabethSamuel-MSFT
Copy link
Collaborator

@ElizabethSamuel-MSFT ElizabethSamuel-MSFT commented May 14, 2025

Q A
Bug fix? no
New feature? no
New sample? no
Related issues? none

What's in this Pull Request?

Adds support for the unified manifest for Microsoft 365.

@ElizabethSamuel-MSFT ElizabethSamuel-MSFT added the Do Not Merge This PR has additional work or review required before it is ready to merge. label May 14, 2025
@ElizabethSamuel-MSFT ElizabethSamuel-MSFT marked this pull request as draft May 14, 2025 23:13
@ElizabethSamuel-MSFT ElizabethSamuel-MSFT changed the title [Word] (citation mgmt) Convert to json manifest [Word] (citation mgmt) Convert to unified manifest May 14, 2025
Comment on lines 76 to 102
{
"requirements": {
"capabilities": [
{
"name": "AddinCommands",
"minVersion": "1.1"
}
]
},
"id": "runtime_2",
"type": "general",
"code": {
"page": "https://localhost:3000/taskpane.html",
"script": "https://localhost:3000/taskpane.js"
},
"lifetime": "short",
"actions": [
{
"id": "ButtonId1_1",
"type": "openPage",
"pinnable": false,
"view": "ButtonId1",
"multiselect": false,
"supportsNoItemContext": false
}
]
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Something's gone wrong here. The "capabilities" asks for AddinCommands 1.1. But the "actions.type" is "openPage" which is for task panes, not add-in commands. Also, the two URLs in "code" are for a task pane. There's no add-in command in this sample and you've already got a runtime for the task pane, just above this one, so I think this should just be deleted.

Copy link
Collaborator Author

@ElizabethSamuel-MSFT ElizabethSamuel-MSFT May 15, 2025

Choose a reason for hiding this comment

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

Actually, I thought this was for the ribbon button, so when you click on it, it opens the task pane...

Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, I thought this was for the ribbon button, so when you click on it, it opens the task pane...

Based on what I see in the original XML manifest, this add-in has only one button and that is a "Show Task Pane" button. But the JSON manifest has two runtime objects in the "runtimes" array. The first one looks correct to be the runtime for the task pane. But this second one seems to have no purpose, and it's an odd mixture of values that are appropriate for a Show Task Pane button and values that are appropriate for a function command button.

@ElizabethSamuel-MSFT ElizabethSamuel-MSFT changed the title [Word] (citation mgmt) Convert to unified manifest [Word] (citation mgmt) Add unified manifest support Jun 27, 2025
- By default, the sample supports the add-in only manifest, which is the **manifest.xml** file in the sample's root directory **Samples/word-citation-management**. For convenience, a copy of the config files specific to this version can be found in the **manifest-configurations/add-in-only** subfolder.
- To run this version, you can skip to the [Run the sample](#run-the-sample) section.
- Unified manifest for Microsoft 365
- To run the unified manifest for Microsoft 365, which is the **manifest.json** file in the sample's root directory **Samples/word-citation-management**, you need to copy the files from the **manifest-configurations/unified** subfolder to the sample's root directory, replacing the existing config files.
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's have the manifest.json in the manifest-configurations/unified subfolder too instead of the root.

@ElizabethSamuel-MSFT ElizabethSamuel-MSFT removed the Do Not Merge This PR has additional work or review required before it is ready to merge. label Jul 7, 2025
@ElizabethSamuel-MSFT ElizabethSamuel-MSFT marked this pull request as ready for review July 7, 2025 18:37
@ElizabethSamuel-MSFT ElizabethSamuel-MSFT merged commit c55a63b into main Jul 8, 2025
1 check passed
@ElizabethSamuel-MSFT ElizabethSamuel-MSFT deleted the eliz-word-citation-mgmt-json branch July 8, 2025 15:28
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.

2 participants