OfficeDev / office-js-docs-pr

Microsoft Office Add-ins Documentation
https://learn.microsoft.com/office/dev/add-ins
Creative Commons Attribution 4.0 International
403 stars 249 forks source link

Link to further explanation regarding the term "entity highlighting" #1412

Closed adem closed 3 years ago

adem commented 5 years ago

When reading an auto-generated manifest from top to bottom in order to understand their meaning, one will encounter the DisableEntityHighlighting property that is set to false as of today. The documentation page doesn't really clarify what's behind the term entity highlighting.

After doing a bit of googling, I suspect it has something to do with contextual add-ins and whether to highlight text fragments (entities?) that match the predefined regex, however I'm not too sure. If it indeed has something to do with contextual add-ins, then it shouldn't be part of the auto-generated manifest in my opinion, as the auto-generated manifest does not specify an ExtensionPoint with attribute DetectedEntity.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

ElizabethSamuel-MSFT commented 5 years ago

@adem Thanks for your query. Yes, that property is related to Outlook contextual add-ins. Can you share how the manifest was generated? That will help us to determine next steps.

Thanks.

adem commented 5 years ago

@ElizabethSamuel-MSFT Hi, the manifest was generated via yo office with the options Office Add-in Task Pane project using React framework, TypeScript, and Outlook.

$ cat manifest.xml | grep Disable
<DisableEntityHighlighting>false</DisableEntityHighlighting>

Here are the versions:

$ npm list -g | grep "yo@"
└─┬ yo@3.1.0
$ npm list -g | grep "generator-office@"
├─┬ generator-office@1.4.0

Thanks!

ElizabethSamuel-MSFT commented 4 years ago

@adem Thanks for your response. We'll look into this.

@akrantz @TCourtneyOwen Can you take a look at this issue?

Thanks.

TCourtneyOwen commented 4 years ago

@adem @ElizabethSamuel-MSFT I will take a look at the Outlook manifest that yo-office uses

TCourtneyOwen commented 4 years ago

I think we can probably safely remove the DisableEntityHighlighting element from the Outlook manifest

ElizabethSamuel-MSFT commented 4 years ago

@TCourtneyOwen Thanks for investigating. Can you update this issue once it is fixed?

Thanks.

ElizabethSamuel-MSFT commented 3 years ago

@adem Can you confirm if this issue is now fixed for you?

Thanks.

adem commented 3 years ago

@ElizabethSamuel-MSFT The element still seems to be part of the manifest - tested with generator-office@1.7.6. However, I'm really not too bothered by it. It doesn't break anything and was just an initial point of confusion in our team. You can go ahead and close the issue.

Thanks!

ElizabethSamuel-MSFT commented 3 years ago

@adem Thanks for letting us know. Closing now.