# Примечания

## Директива `admonition`

Базовый синтаксис директивы:

````{myst-example}
```{admonition}
Общее примечание `admonition`.
```
````

````{myst-example}
```{admonition} Заголовок
Примечание `admonition` с заголовком.
```
````

## Производные примечания

Данные примечания можно использовать через собственное название директивы, либо через опцию `:class:` директивы `admonition`.

### `note`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{note}
Примечание `note`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Примечание
:class: note

Примечание `note`.
```
````
`````
``````

### `seealso`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{seealso}
Примечание `seealso`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} См.также
:class: seealso

Примечание `seealso`.
```
````
`````
``````

### `tip`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{tip}
Примечание `tip`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Совет
:class: tip

Примечание `tip`.
```
````
`````
``````

### `hint`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{hint}
Примечание `hint`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Подсказка
:class: hint

Примечание `hint`.
```
````
`````
``````

### `important`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{important}
Примечание `important`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Важно
:class: important

Примечание `important`.
```
````
`````
``````

### `attention`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{attention}
Примечание `attention`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Внимание
:class: attention

Примечание `attention`.
```
````
`````
``````

### `caution`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{caution}
Примечание `caution`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Осторожно
:class: caution

Примечание `caution`.
```
````
`````
``````

### `warning`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{warning}
Примечание `warning`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Предупреждение
:class: warning

Примечание `warning`.
```
````
`````
``````

### `danger`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{danger}
Примечание `danger`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Опасно
:class: danger

Примечание `danger`.
```
````
`````
``````

### `error`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{error}
Примечание `error`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Ошибка
:class: error

Примечание `error`.
```
````
`````
``````

### `info`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{info}
Примечание `info`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Info
:class: info

Примечание `info`.
```
````
`````
``````

### `abstract`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{abstract}
Примечание `abstract`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Abstract
:class: abstract

Примечание `abstract`.
```
````
`````
``````

### `success`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{success}
Примечание `success`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Success
:class: success

Примечание `success`.
```
````
`````
``````

### `question`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{question}
Примечание `question`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Question
:class: question

Примечание `question`.
```
````
`````
``````

### `failure`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{failure}
Примечание `failure`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Failure
:class: failure

Примечание `failure`.
```
````
`````
``````

### `bug`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{bug}
Примечание `bug`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Bug
:class: bug

Примечание `bug`.
```
````
`````
``````

### `example`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{example}
Примечание `example`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Пример
:class: example

Примечание `example`.
```
````
`````
``````

### `quote`

``````{md-tab-set}
`````{md-tab-item} Конкретная директива
````{myst-example}
```{quote}
Примечание `quote`.
```
````
`````
`````{md-tab-item} Общая директива
````{myst-example}
```{admonition} Quote
:class: quote

Примечание `quote`.
```
````
`````
``````

## Опции

Перечисленные ниже опции доступны для всех примечаний.

```{rst:directive:option} title
```

С помощью данной опции можно указать альтернативный заголовок для примечания. Если заголовок указан в аргументе директивы, то это значение будет объединено со значением опции.

````{myst-example}
```{hint}
Примечание `hint`.
```
````

````{myst-example}
```{hint}
:title: Альтернативный заголовок

Примечание `hint` с альтернативным заголовком.
```
````

````{myst-example}
```{admonition} Заголовок из аргумента
:title: Заголовок из опции

Примечание с объединенным заголовком.
```
````

```{rst:directive:option} no-title
```

Данный флаг убирает отображение заголовока примечания. Эта опция вызовет такое же поведение, как у директивы `admonition` без предоставления аргумента.

````{myst-example}
```{success}
:no-title:

Примечание `success` без заголовка.
```
````

````{myst-example}
```{admonition}
Примечание `admonition` без заголовка.
```
````

```{rst:directive:option} collapsible
```

Данный параметр можно использовать для преобразования отображаемого примечания в сворачиваемый элемент HTML `<details>`. Значение `open` сделает примечание развернутым по умолчанию. Любое другое значение игнорируется и сделает уведомление свернутым по умолчанию. Также см. [описание директивы `dropdown`](#директива-dropdown).

````{myst-example}
```{example} Открыто по умолчанию
:collapsible: open

Развернутое примечание.
```
````

````{myst-example}
```{question} Свернуто по умолчанию
:collapsible:

Свернутое примечание.
```
````

```{rst:directive:option} name
```

Данная опция устанавливает идентификатор для ссылки на примечание из других частей документации с помощью [роли `ref`](https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html#reference-roles).

````{myst-example}
```{quote} Ссылка на примечание
:name: my-admonition

Ссылка на {ref}`это примечание <my-admonition>`
```
````

```{rst:directive:option} class
```

Данная опция используется для применения пользовательских стилей к примечанию. В директиве `admonition` ее можно использовать для [выбора типа примечания](#производные-примечания).

````{myst-example}
```{admonition}
:class: danger

Примечание `danger`.
```
````

## Директива `dropdown`

Для удобства есть директива `dropdown`, которая неявно является директивой `admonition` с уже установленным параметром `:collapsible:`.

Помимо основных опций, описанных выше, у `dropdown` есть еще `:open:`, которая раскрывает примечание.

````{myst-example}
```{dropdown}
Пример свернутого примечания.
```
````

````{myst-example}
```{dropdown}
:open:

Пример развернутого примечания.
```
````

````{myst-example}
```{dropdown}
:open:
:class: example

Пример свернутого примечания `example`.
```
````
