Использование тегов заметок на страницах OneNoteUse note tags in OneNote pages

Относится к: обычным записным книжкам в OneDrive | корпоративные записные книжки в Office 365Applies to Consumer notebooks on OneDrive | Enterprise notebooks on Office 365

С помощью атрибута data-tag вы можете добавлять и изменять флажки, звездочки и другие встроенные теги заметок на странице OneNote, как показано на рисунке ниже.Use the data-tag attribute to add and update check boxes, stars, and other built-in note tags on a OneNote page, as shown in the following image.

Три тега заметок, отображаемые на странице OneNote.

Атрибуты тегов заметокNote tag attributes

В HTML-коде страницы OneNote тег заметки представлен атрибутом data-tag.In the HTML of a OneNote page, a note tag is represented by the data-tag attribute. Пример:For example:

  • Снятый флажок задачи: <p data-tag="to-do">An unchecked to-do box: <p data-tag="to-do">

  • Установленный флажок задачи: <p data-tag="to-do:completed">A checked to-do box: <p data-tag="to-do:completed">

  • Звездочка: <h2 data-tag="important">A star: <h2 data-tag="important">

Значение data-tag состоит из фигуры и (иногда) из состояния (см. все поддерживаемые значения).A data-tag value is composed of a shape, and sometimes a status (see all supported values).

СвойствоProperty ОписаниеDescription
shapeshape Идентификатор тега заметки (пример: to-do или important).The identifier of the note tag (example: to-do or important).
statusstatus Состояние тегов заметок с флажками.The status of check box note tags. Это свойство используется только для установки флажков выполненных задач.This is used only to set check boxes as completed.

Добавление или изменение тегов заметокAdd or update note tags

Добавить или изменить тег заметки можно с помощью атрибута data-tag в поддерживаемом элементе.To add or update a built-in note tag, just use the data-tag attribute on a supported element. Например, вот абзац, помеченный как важный:For example, here's a paragraph marked as important:

<p data-tag="important">...</p>

Разделение нескольких тегов заметок запятыми:Separate multiple note tags with commas:

<p data-tag="important, critical">...</p>

Вы можете задать атрибут data-tag для указанных ниже элементов.You can define a data-tag on the following elements:

Список тегов заметок, которые можно использовать в Microsoft Graph, см. в разделе Встроенные теги заметок.See Built-in note tags for a list of note tags that you can use with Microsoft Graph. Добавление и изменение пользовательских тегов с помощью Microsoft Graph не поддерживается.Adding or updating custom tags using Microsoft Graph is not supported.

ПримерыExamples

Ниже показан простой список дел, в котором первый элемент завершен.Here's a simple to-do list with the first item completed.

<p data-tag="to-do:completed" data-id="prep">Till garden bed</p> 
<p data-tag="to-do" data-id="spring">Plant peas and spinach</p>
<p data-tag="to-do" data-id="summer">Plant tomatoes and peppers</p>

Обратите внимание, что теги <p> над каждым пунктом включают атрибут data-id.Note that the <p> tags above each include a data-id attribute. Это упрощает изменение тегов заметок с флажками.This makes it easier to update the check box note tags. Например, показанный ниже запрос помечает элемент списка дел (посвященный весенней высадке растений) как выполненный.For example, the following request marks the spring planting to-do item as completed.

PATCH https://graph.microsoft.com/v1.0/me/onenote/notebooks/pages/{page-id}/content

Content-Type: application/json
Authorization: Bearer {token}

[
   {
    'target':'#spring',
    'action':'replace',
    'content':'<p data-tag="to-do:completed"  data-id="spring">Plant peas and spinach</p>'
  }
]

Показанный ниже запрос создает страницу, которая содержит все встроенные теги заметок.The following request creates a page that contains all built-in note tags.

POST https://graph.microsoft.com/v1.0/me/onenote/notebooks/pages

Content-Type: text/html
Authorization: Bearer {token}


<!DOCTYPE html>
<html>
  <head>
    <title data-tag="to-do:completed">All built-in note tags</title>
  </head>
  <body>
    <h1 data-tag="important">Paragraphs with built-in note tags</h1>
    <p data-tag="to-do">to-do</p>
    <p data-tag="important">important</p>
    <p data-tag="question">question</p>
    <p data-tag="definition">definition</p>
    <p data-tag="highlight">highlight</p>
    <p data-tag="contact">contact</p>
    <p data-tag="address">address</p>
    <p data-tag="phone-number">phone-number</p>
    <p data-tag="web-site-to-visit">web-site-to-visit</p>
    <p data-tag="idea">idea</p>
    <p data-tag="password">password</p>
    <p data-tag="critical">critical</p>
    <p data-tag="project-a">project-a</p>
    <p data-tag="project-b">project-b</p>
    <p data-tag="remember-for-later">remember-for-later</p>
    <p data-tag="movie-to-see">movie-to-see</p>
    <p data-tag="book-to-read">book-to-read</p>
    <p data-tag="music-to-listen-to">music-to-listen-to</p>
    <p data-tag="source-for-article">source-for-article</p>
    <p data-tag="remember-for-blog">remember-for-blog</p>
    <p data-tag="discuss-with-person-a">discuss-with-person-a</p>
    <p data-tag="discuss-with-person-b">discuss-with-person-b</p>
    <p data-tag="discuss-with-manager">discuss-with-manager</p>
    <p data-tag="send-in-email">send-in-email</p>
    <p data-tag="schedule-meeting">schedule-meeting</p>
    <p data-tag="call-back">call-back</p>
    <p data-tag="to-do-priority-1">to-do-priority-1</p>
    <p data-tag="to-do-priority-2">to-do-priority-2</p>
    <p data-tag="client-request">client-request</p>
    <h1 data-tag="important">Paragraphs with check boxes marked with "completed" status</h1>
    <p data-tag="to-do:completed">to-do:completed</p>
    <p data-tag="discuss-with-person-a:completed">discuss-with-person-a:completed</p>
    <p data-tag="discuss-with-person-b:completed">discuss-with-person-b:completed</p>
    <p data-tag="discuss-with-manager:completed">discuss-with-manager:completed</p>
    <p data-tag="schedule-meeting:completed">schedule-meeting:completed</p>
    <p data-tag="call-back:completed">call-back:completed</p>
    <p data-tag="to-do-priority-1:completed">to-do-priority-1:completed</p>
    <p data-tag="to-do-priority-2:completed">to-do-priority-2:completed</p>
    <p data-tag="client-request:completed">client-request:completed</p>
    <h1 data-tag="important">Multiple note tags</h1>
    <p data-tag="project-a,  client-request:completed">Two note tags:  project-a, client-request:completed</p>
    <p data-tag="idea, send-in-email, question">Three note tags:  idea, send-in-email, question</p>
    <h1 data-tag="important">Using note tags with other elements</h1>
    <p><b>Note tag on a list item:</b></p>
    <ul>
      <li data-tag="to-do-priority-1:completed">Make a to-do list</li>
    </ul>
    <p><b>Note tag on an image:</b></p>
    <img data-tag="source-for-article" src="https://placecorgi.com/200" />
    <p><b>Note tag with embedded style:</b></p>
    <p data-tag="important">Next time, <b>don't</b> forget to invite <span style="background-color:yellow">Dan</span>.</p>
  </body>
</html>

Дополнительные сведения о создании страниц см. в статье Создание страниц в OneNote.For more information about creating pages, see Create OneNote pages. Дополнительные сведения об изменении страниц см. в статье Обновление страниц в OneNote.For more about updating pages, see Update OneNote pages.

Теги заметок в спискахNote tags on lists

Ниже приведены рекомендации по работе с тегами заметок в списках.Here are some guidelines for working with note tags on lists:

  • Используйте элементы p для списков дел.Use p elements for to-do lists. Они не отображают маркеры или числа, и их проще изменять.They don't display a bullet or number, and they're easier to update.

  • Для создания или обновления списков, в которых отображается один и тот же тег заметки для всех элементов списка, определите атрибут data-tag в элементе ul или ol.To create or update lists that display the same note tag for all list items, define data-tag on the ul or ol. Чтобы изменить весь список, вам потребуется повторно определить атрибут data-tag в элементе ul или ol.To update the entire list, you'll need to redefine data-tag on the ul or ol.

  • Для создания или обновления списков, в которых отображается уникальный тег заметки для некоторых или всех элементов списка, определите атрибут data-tag в элементах li и не вкладывайте элементы li в элемент ul или ol.To create or update lists that display a unique note tag for some or all list items, define data-tag on li elements, and don't nest the li elements in a ul or ol. Чтобы изменить весь список, вам потребуется удалить элемент ul, возвращенный в выходном HTML-коде, и предоставить только невложенные элементы li.To update the entire list, you'll need to remove the ul that's returned in the output HTML and provide only the unnested li elements.

  • Чтобы обновить определенные элементы li, настройте элементы li индивидуально и определите атрибут data-tag в элементе li.To update specific li elements, target the li elements individually and define the data-tag on the li element. Любой элемент li с индивидуальной адресацией можно изменить так, чтобы он отображал уникальный тег заметки независимо от того, как изначально был определен список.Any individually addressed li element can be updated to display a unique note tag, no matter how the list was originally defined.

    Рекомендации основаны на указанных ниже правилах, применяемых Microsoft Graph.The guidelines are based on the following rules that are applied by Microsoft Graph:

    • Параметр data-tag для элемента ul или ol переопределяет все параметры в дочерних элементах li.The data-tag setting for a ul or ol overrides all settings on child li elements. Это правило применяется, даже если в элементах ul или ol не указан атрибут data-tag, но он указан в дочерних элементах li.This applies even when the ul or ol doesn't specify a data-tag but its child li elements do.

      Например, если вы создаете элемент ul или ol, который определяет атрибут data-tag="project-a", то все его элементы будут отображать тег заметки Project A.For example, if you create a ul or ol that defines data-tag="project-a", all its list items will display the Project A note tag. Если элемент ul или ol не определяет атрибут data-tag, ни один из его элементов не будет отображать тег заметки.Or if the ul or ol doesn't define a data-tag, none of its items will display a note tag. Это переопределение происходит независимо от любых явных параметров в дочерних элементах li.This override happens regardless of any explicit settings on child li elements.

  • Уникальные параметры data-tag применяются к элементам списка в указанных ниже условиях.Unique data-tag settings are honored for list items under the following conditions:

    • Элементы li не вложены в элемент ul или ol в запросе на создание или изменение.The li elements are not nested in a ul or ol in a create or update request.

    • Элемент li имеет индивидуальную адресацию в запросе на изменение.An li element is individually addressed in an update request.

  • Невложенные элементы li, отправленные во входном HTML-коде, возвращаются в элементе ul в выходном HTML-коде.Unnested li elements sent in input HTML are returned in a ul in the output HTML.

  • В выходном HTML-коде все параметры списка data-tag определены в элементах span в элементах списка.In output HTML, all data-tag list settings are defined on span elements on the list items.

В приведенном ниже коде показано, как применять некоторые из этих правил.The following code shows how some of these rules are applied. Входной HTML-код создает два списка с тегами заметок.The input HTML creates two lists with note tags. Выходной HTML-код — это то, что система возвращает для списков, когда вы получаете контент страницы.The output HTML is what's returned for the lists when you retrieve page content.

Входной HTML-кодInput HTML

<!--To display the same note tag on all list items, define note tags on the ul or ol.--> 
<ul data-tag="project-a" data-id="agenda">
  <li>An item with a Project A note tag</li>
  <li>An item with a Project A note tag</li>
</ul>

<!--To display unique note tags on list items, don't nest li elements in a ul or ol.--> 
<li data-tag="idea" data-id="my-idea">An item with an Idea note tag</li>
<li data-tag="question" data-id="my-question">An item with a Question note tag</li>

Выходной HTML-кодOutput HTML

<ul>
  <li><span data-tag="project-a">An item with a Project A note tag</span></li>
  <li><span data-tag="project-a">An item with a Project A note tag</span></li>
</ul>
<br />
<ul>
  <li style="..."><span data-tag="idea">An item with an Idea note tag</span></li>
  <li style="..."><span data-tag="question">An item with a Question note tag</span></li>
</ul>

Получение тегов заметокRetrieve note tags

Встроенные теги заметок включаются в выходной HTML, когда вы получаете контент страницы:Built-in note tags are included in the output HTML when you get page content:

GET ../api/v1.0/pages/{page-id}/content

Атрибут data-tag в выходном HTML-коде всегда включает значение фигуры. Он включает состояние, только если он представляет тег заметки с установленным флажком (для выполненного элемента списка).A data-tag attribute in the output HTML always includes a shape value, and it only includes a status if it represents a check box note tag that's set to completed. В примерах ниже показан входной HTML-код, используемый для создания некоторых тегов заметок, и возвращаемый выходной HTML-код.The following examples show the input HTML used to create some note tags and the output HTML that's returned.

Входной HTML-кодInput HTML

<h1>Status meeting</h1>
<p data-tag="important">Next week's meeting has been moved to <b>Wednesday</b>.</p>
<p data-tag="question">What are the exact dates for the conference?</p>
<p>Upcoming training opportunities. See Katie for more info.</p>
<p data-tag="project-a">Around the room updates.</p>
<ul data-tag="critical">
  <li>Design handouts</li>
  <li>Plan keynote</li>
</ul>

Выходной HTML-кодOutput HTML

<h1 style="...">Status meeting</h1>
<p data-tag="important">Next week's meeting has been moved to <span style="font-weight:bold">Wednesday</span>.</p>
<p data-tag="question">What are the exact dates for the conference?</p>
<p>Upcoming training opportunities. See Katie for more info.</p>
<p data-tag="project-a">Around the room updates.</p>
<ul>
  <li><span data-tag="critical">Design handouts</span></li>
  <li><span data-tag="critical">Plan keynote</span></li>
</ul>

Обратите внимание, что атрибут data-tag, определенный на уровне списка, передается в его элементы списка.Note that the data-tag attribute defined at the list level is pushed to its list items. Дополнительные сведения об использовании тегов заметок со списками см. в статье Теги заметок в списках.For more information about using note tags with lists, see Note tags on lists.

Примечание. В выходном HTML-коде определение и теги заметок "Запомнить" возвращаются в виде атрибута data-tag="remember-for-later".Note: In the output HTML, the definition and remember-for-later note tags are both returned as data-tag="remember-for-later". Элемент title не возвращает никаких сведений о тегах заметок.The title element doesn't return any note tag information.

Встроенные теги заметок для OneNoteBuilt-in note tags for OneNote

В OneNote имеются указанные ниже встроенные теги заметок.OneNote includes the following built-in note tags:

Все встроенные теги заметок.

Значения, которые можно присвоить атрибуту data-tag, показаны в следующей таблице.The values you can assign to the data-tag attribute are shown in the following table. Пользовательские теги не поддерживаются.Custom tags are not supported.

ТегиTags
shape[:status] to-do

to-do:completed
important
question definition highlight
contact address phone-number
web-site-to-visit idea password
critical project-a project-b
remember-for-later movie-to-see book-to-read
music-to-listen-to source-for-article remember-for-blog
discuss-with-person-a

discuss-with-person-a:completed
discuss-with-person-b

discuss-with-person-b:completed
discuss-with-manager

discuss-with-manager:completed
send-in-email schedule-meeting

schedule-meeting:completed
call-back

call-back:completed
to-do-priority-1

to-do-priority-1:completed
to-do-priority-2

to-do-priority-2:completed
client-request

client-request:completed

Сведения в откликеResponse information

Microsoft Graph возвращает указанные ниже сведения в отклике.Microsoft Graph returns the following information in the response.

Данные в откликеResponse data ОписаниеDescription
Код успешного завершения действияSuccess code Код состояния HTTP 201 при успешном выполнении запроса POST и код состояния HTTP 204 при успешном выполнении запроса PATCH.A 201 HTTP status code for a successful POST request, and a 204 HTTP status code for a successful PATCH request.
ОшибкиErrors Дополнительные сведения об ошибках OneNote, которые может возвращать Microsoft Graph, см. в статье Коды ошибок для API OneNote в Microsoft Graph.Read Error codes for OneNote APIs in Microsoft Graph to learn about OneNote errors that Microsoft Graph can return.

РазрешенияPermissions

Чтобы можно было создавать или изменять страницы OneNote, вам придется запросить соответствующие разрешения.To create or update OneNote pages, you'll need to request appropriate permissions. Выберите минимальный уровень разрешений, необходимый для работы вашего приложения.Choose the lowest level of permissions that your app needs to do its work.

Разрешения для запросов POST со страницамиPermissions for POST pages

  • Notes.CreateNotes.Create
  • Notes.ReadWriteNotes.ReadWrite
  • Notes.ReadWrite.AllNotes.ReadWrite.All

Разрешения в случае запросов PATCH для страницPermissions for PATCH pages

  • Notes.ReadWriteNotes.ReadWrite
  • Notes.ReadWrite.AllNotes.ReadWrite.All

Дополнительные сведения об областях разрешений и принципе их работы см. в разделе Области разрешений OneNote.For more information about permission scopes and how they work, see OneNote permission scopes.

См. такжеSee also