Skip to content

Commit

Permalink
[All Hosts] (manifest) document function name length limitation (#4461)
Browse files Browse the repository at this point in the history
* [All Hosts] (manifest) document function name length limitation

* better formatting

* Apply suggestions from code review

Co-authored-by: Elizabeth Samuel <elizs@microsoft.com>

* Update docs/develop/convert-xml-to-json-manifest.md

* Update date

---------

Co-authored-by: Elizabeth Samuel <elizs@microsoft.com>
  • Loading branch information
Rick-Kirkham and ElizabethSamuel-MSFT committed May 3, 2024
1 parent 60700a4 commit ac3321b
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions docs/develop/convert-xml-to-json-manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
title: Convert an add-in to use the unified manifest for Microsoft 365
description: Learn the various methods for converting an add-in with an XML manifest to the unified manifest for Microsoft 365 and sideload the add-in.
ms.topic: how-to
ms.date: 07/27/2023
ms.date: 04/12/2024
ms.localizationpriority: medium
---

# Convert an add-in to use the unified manifest for Microsoft 365 (preview)
# Convert an add-in to use the unified manifest for Microsoft 365

To add Teams capabilities to an add-in that uses the XML manifest, or to just future proof the add-in, you need to convert it to use the unified manifest for Microsoft 365.

There are three basic tasks to converting an add-in project from the XML manifest to the unified manifest.

- Ensure that you have 64x64 pixel and 128x128 pixel images files to serve as icons for the add-in.
- Ensure that your add-in is ready to convert.
- Convert the XML manifest itself to the JSON format of the unified manifest.
- Package the new manifest and main icon and high resolution icon image files into a zip file for sideloading or deployment.

Expand All @@ -23,9 +23,11 @@ There are three basic tasks to converting an add-in project from the XML manifes
> - Projects created in Visual Studio, as distinct from Visual Studio Code, can't be converted at this time.
> - If you [created the project with Teams Toolkit](teams-toolkit-overview.md) or with the "unified manifest" option in the [Office Yeoman Generator](yeoman-generator-overview.md), it already uses the unified manifest.
## Ensure that you have the two image files
## Ensure that your add-in is ready to convert

It's highly likely that you have the two image files already in your add-in. They're specified in the [IconUrl](/javascript/api/manifest/iconurl) and [HighResolutionIconUrl](/javascript/api/manifest/highresolutioniconurl) elements in the XML manifest. Because these are both optional elements, your add-in project mignt not have one or both. These are required for an add-in that uses the unified manifest, so you need to create them if the project doesn't already have them. For guidance, see [Create an icon for your add-in](/office/dev/store/create-effective-office-store-listings#create-an-icon-for-your-add-in).
### Ensure that you have the two image files

It's highly likely that you already have the two image files in your add-in. They're specified in the [IconUrl](/javascript/api/manifest/iconurl) and [HighResolutionIconUrl](/javascript/api/manifest/highresolutioniconurl) elements in the XML manifest. Because these are both optional elements, your add-in project might not have one or both. These are required for an add-in that uses the unified manifest, so you need to create them if the project doesn't already have them. For guidance, see [Create an icon for your add-in](/office/dev/store/create-effective-office-store-listings#create-an-icon-for-your-add-in).

When you've added the files to the project, add **\<IconUrl\>** and **\<HighResolutionIconUrl\>** (in that order) to the XML manifest just below the **\<Description\>** element. The following is an example.

Expand All @@ -43,6 +45,10 @@ When you've added the files to the project, add **\<IconUrl\>** and **\<HighReso
<!-- Other markup omitted -->
```

### Ensure that your function command names are short enough

If your manifest has any **\<FunctionName\>** elements, make sure their values have fewer than 65 characters. The value of this element must exactly match the name of a function in a JavaScript or TypeScript file. If you change it in the manifest, be sure to change it in the code file too.

## Conversion tools and options

There are several ways to carry out the remaining tasks, depending on the IDE and other tools you want to use for your project, and on the tool you used to create the project.
Expand Down

0 comments on commit ac3321b

Please sign in to comment.