Microsoft 365 Community Community Demos, 8 Sep 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Word API Preview: Footnote and Comment APIs

Description

In this 9-minute Developer-focused demo, Ruoying Liang delivers a Preview on the latest Microsoft Word API updates - Footnote and Comment APIs. The Footnote API enables users to insert searchable citations with reference marks into documents. Like how comments are added to a cell in Excel, the new Comments API allows users to add comments to a specified range, paragraph, table in Word. One can reply to, resolve, view and delete comments. Supports URL and rich text. Beta rollout presently, on-line only. This PnP Community demo is taken from the Office Add-ins community call – September 2021, recorded on September 8, 2021.

Demo Presenter: Ruoying Liang, Senior Program Manager (Microsoft)

Stay connected:
• Learn more about the Microsoft 365 Patterns and Practices community at: http://aka.ms/m365pnp
• Visit the Microsoft 365 Patterns and Practices community YouTube channel: https://aka.ms/m365pnp/videos

A

Hi everyone I'm roy ying, I'm the program manager in office platform team.

A

Today, I would like to update some new investment in world api area, as you may know that we've posted the investigating new investigation in for word ide for a while, during this time we're continuing hearing your feedbacks and the requirements, and we know that there are still strong needs to have to build new features and fulfill new scenarios in world ide. So I'd like to share here that work or are continuing the investment in world adding area um today, I would like to share some new updates.

A

First of all, I want to introduce what targeting scenarios are looking into first one. It's the citation management, so word is crucial for official and professional documents. We all know that the citation is the is a key for a professional document.

A

We've had a lot of great ideas who can support a great list of parts of scenarios and provide solutions for people to easily manage their citation, so they can add the accurate citation to their document and manage them in future, but now it still have some api gaps for them to uh to support this scenario, and the next one is about the content insertion.

A

So it's works about a lot of different objects. uh Apis already support, many of them like the tables table cells, content control, shapes a lot of objects already supported, but still have some gaps so now we're looking into those different objects and trying to support more so. The first api I would like to introduce is about footnote, which is a key asset of the citation um for the footnote api.

A

We will provide the ability to first of all, add edit and delete, and we also can let you to get the footnote from any place you want, and then, with the with that, you can also get the footnotes by the sequence. For example, you can get the next footnote or the first.

A

Fourth note the last of the note, and you can also get it from different object, no matter it's in a table or in a paragraph or in content control, as you know, that footnote has a reference mark in the in the document, so the users can get the footnote from the reference mark and can also get the reference mark from the footnote and, as you may know, that the document body actually don't include the footnote part.

A

So currently, if you want to set the selection to the footnote, it's not doable, but with this api you can set the focus focus to for notes directly and definitely you can set your you can update it. Based on your selection and last but not least, is we support the search function? um Currently, the documentary search well, the body does search, will search the whole body of the documents, but with this api we will have, we will support to search, including both the main document and the footnotes.

A

This is a list of the objects we support, but for not so you can see that you can see the whole object. Structures are supported for the nodes, so you can get through nodes from different level and the two note itself will name the ads note item, but not for notes, because it will support both footnote and endnote.

A

For the first release, we will only support footnotes, but in future the note item can be either for notes of all the endnotes and you can get the diff. You can get type from the node item.type okay. So this is the footnote api.

A

The next one is about the comment, um the modern comments. Actually, we we have the we have the apis involved for excel, and now we are introducing this apis to word, the main design are similar, but the way how we also have some difference.

A

First of all, uh we also is the power to add the comment and add reply or edit or delete, as you may notice that you can only edit your own comments.

A

If from adding is also the same, you can only edit your own comments and cannot edit other people's comments and with the uh as with the delete, you can delete a thread or only delete a reply.

A

Besides those actions, you also get the comments, and the word has a new features to support the comments with rich text, so you can also see you can have a structured comments or you can have the url link into in your comments and provide a more reachable experience in your id.

A

These two apis other apis I like to introduce today, will also enabled the bookmark apis in online, as you may know that previously this api has enabled the university 2 with the with the new update. We will support it. Also in word online.

A

We have a demo quick demo to show those uh how to use this uh two apis in the citation management scenario and the common scenario. So uh you can see uh this. Imagine I'm a student, I'm writing a homework. The teacher asked me to write an article, so I read an article about coding, 19 vaccines.

A

After I write the main content, I want to add some footnote. For some words, I have an id which saves my citations, so you can add the footnote into the document and then you can set focus to check okay. This is the footnote that I want to add and, after I add all the footnotes, I'd like to share the document to my teachers.

A

So, as a teacher, I'm a reviewer, I want to add some comments to my students.

A

I think this is a networking, so I'm in my in my screen is also continue loading, but I can continue to explain what the value is doing. It's the idea. The teachers can add the comments into the document and then, after uh after they do that, you can also insert the overall summary of the comments and the grades to the students.

A

So this is the whole experience of edit footnotes and the insert comments and get comments. We have a lot of more action support. You can get more details once we have the document released, so I would like to emphasize that the word apis are currently well released to online. First, we will have a requirement set as word api online and those apis will be only available in online at the first release and the full note api and comments api are already in the process of rolling out to beta.

A

So suppose it will be ready in a couple of weeks to you can try it in beta cdn with the preview link. So this is a introduction of the new api and if you have any questions feedback so or thinking of the different scenarios, uh you please feel free to contact me and would like to talk more. Thank you.

B

Inspecting, thank you. That's really awesome. I saw from the comments some people are excited about this. um It looked like there might have been a question or two in there. Roying.

A

B

You want to take a look at the web chat.