Опишите модели Используя примечания и аннотации

Можно описать модель с примечаниями и аннотациями, чтобы помочь другим изучить его. Можно добавить примечания в любую систему в иерархии модели путем введения текста, показа содержимого веб-сайта или наследования содержимого примечания от родительской системы. Для каждой системы можно также принять решение не показать любые примечания.

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

Текстовые аннотации могут содержать любую комбинацию:

  • Текст

  • Изображения

  • Уравнения с помощью LaTeX и команд MathML

  • Гиперссылки, которые открывают веб-сайт или выполняют функции MATLAB®

Кроме того, можно создать аннотацию только для изображения.

Управляйте примечаниями

Чтобы начать, во вкладке Modeling, под Design, нажимают Notes. Если модель имеет примечания, сопоставленные с ним, они появляются в панели справа от модели. Когда вы перемещаетесь по иерархии, примечания для каждой системы появляются. Если модель не имеет примечаний, можно добавить их.

Примечания хранятся в файле с дополнительным .mldatx. Если вы хотите, чтобы ваша модель имела примечания, сначала создайте файл примечаний. Смотрите Добавляют и Примечания Редактирования. После того, как вы создаете файл, примечания, которые вы добавляете, сохраняются автоматически.

У вас может быть несколько файлов примечаний, сопоставленных с той же моделью, например, для пользователей с различными ролями. Человек, использующий модель, может затем выбрать среди файлов примечаний, которые совпадают с вашей моделью. Файлы примечаний содержат имя модели и информацию о версии, чтобы гарантировать файл примечаний и соответствие модели.

.mldatx файл сохранен отдельный от модели. Если вы перемещаете свою модель в различную папку, .mldatx файл также не перемещается, но ассоциация остается, если файл находится на пути MATLAB.

Читайте и режимы редактирования

Используйте панель Notes, чтобы отредактировать и считать примечания. Используйте переключатель Read/Edit Notes, чтобы переключиться между режимами. Когда вы нажимаете Edit Notes, особенности редактирования включены. Когда вы нажимаете Read Notes, особенности редактирования не доступны. Вместо этого содержимое отображается в формате только для чтения. Когда вы перемещаетесь по модели, обновлениям панели Notes с содержимым для существующей системы.

Добавьте и отредактируйте примечания

  1. В модели, на вкладке Modeling, под Design, нажимают Notes. Интерфейс примечаний появляется справа от модели и включает инструкции начать.

  2. Нажмите кнопку Create a notes file.

  3. Введите имя для файла примечаний, или используйте имя по умолчанию и нажмите Save.

  4. Панель Notes находится в режиме редактирования. Можно добавить примечания этими способами:

    • Введите текст в текстовом редакторе.

    • В меню выберите Use URL for Notes и введите URL, содержимое которого вы хотите показать примечаниями для существующей системы.

    • Перейдите к различной системе в модели и введите текст, используйте URL или выберите Show Parent Notes.

    • Выберите No Notes.

  5. Когда вы закончите добавлять и редактировать, кликните по кнопке-переключателю Read Notes, чтобы поместить примечания в чтение режима.

Чтобы отредактировать примечания от чтения режима, перейдите к системе, содержимое которой вы хотите отредактировать и кликнуть по кнопке-переключателю Edit Notes.

Управляйте аннотациями

Чтобы создать текстовую аннотацию, используйте одну из этих опций:

  • Дважды кликните холст, где вы хотите создать аннотацию и выбрать Create Annotation из меню.

  • Кликните по полю аннотации на палитре Editor Simulink® и затем кликните по холсту.

  • Перетащите поле аннотации к холсту.

После того, как вы добавите текстовую аннотацию, вы можете:

  • Примените изменения форматирования к тексту или вставьте изображение, таблицу или уравнение с помощью панели форматирования.

  • Примените дополнительное форматирование, с помощью меню Paragraph в контекстном меню. Например, можно создать маркер и пронумерованные списки в этом меню.

  • Добавьте гиперссылки с помощью контекстного меню. Можно использовать гиперссылки, чтобы открыть веб-сайт или сделать аннотацию интерактивными командами MATLAB использования.

  • Примените свойства с помощью Property Inspector. Чтобы просмотреть Property Inspector, во вкладке Modeling, под Design, нажимают Property Inspector.

Измените размер аннотации

Аннотация изменяет размер, когда вы вводите содержимое. Можно также изменить размер аннотации путем перетаскивания углов. Например, можно содержать Shift, когда вы перетаскиваете, чтобы изменить размер пропорционально.

После того, как вы изменяете размер аннотации, аннотация остается, что размер, пока вы не изменяете размер его снова, независимо от размера содержимого. Чтобы вернуться к исходной высоте или ширине аннотации, в Property Inspector, под Appearance, снимают флажок Fixed height или Fixed width.

Сделайте аннотацию интерактивной

Чтобы сделать аннотацию интерактивной, используйте гиперссылку на любом содержимом текстовой аннотации.

  1. В аннотации выберите содержимое, которое вы хотите сделать интерактивным. Чтобы сделать целую аннотацию интерактивной, выберите все содержимое.

  2. Щелкните правой кнопкой и выберите Hyperlink из контекстного меню.

  3. В диалоговом окне Hyperlink, также:

    • Выберите URL Address как цель и введите веб-адрес в поле Code.

    • Выберите MATLAB Code как цель и введите функции MATLAB в поле Code.

  4. Нажмите OK.

Для альтернативного подхода смотрите Функции обратного вызова Аннотации.

Добавьте аннотацию изображений

Когда это необходимо, чтобы изменить размер или переместить изображение независимо из текста, создайте аннотацию изображений. Например, можно измерить и расположить логотип компании в конкретном местоположении в модели. Можно также вызвать функции MATLAB нажатием кнопки на изображении. Чтобы добавить аннотацию, которая содержит изображение, перетащите изображение от своей файловой системы до холста.

Совет

Чтобы включать изображение, такое как логотип в каждой новой модели, добавьте изображение в свой шаблон по умолчанию. Смотрите Создают Шаблон из Модели.

В качестве альтернативы можно перетащить поле Image из палитры на холст. Затем вы можете также:

  • Дважды кликните поле изображения и обзор к изображению.

  • Вставьте изображение от буфера обмена. Щелкните правой кнопкой по полю изображения и выберите Paste Image.

Совет

Если вы изменяете размер изображения, можно сбросить его к его первоначальному размеру. Щелкните правой кнопкой по изображению и выберите Format> Restore Size.

Сопоставлять действие с изображением:

  1. Выберите изображение.

  2. В Property Inspector, под ClickFcn, добавляют функции MATLAB, которые вы хотите вызвать нажатием кнопки на изображение.

Добавьте уравнения в аннотации

Можно добавить уравнения в аннотацию путем нажатия кнопки Insert Equation на панели форматирования аннотации.

В диалоговом окне Edit Equation введите LaTeX или код MathML, чтобы сгенерировать уравнения. Для команд LaTeX смотрите, Вставляют уравнение LaTeX (MATLAB).

Чтобы отредактировать код уравнения, дважды кликните уравнение в аннотации. Подобно тексту в аннотациях можно отформатировать уравнения в аннотациях при помощи панели форматирования. Можно изменить цвет шрифта, текстовый цвет подсветки, размер шрифта и местоположение уравнений в аннотациях.

Можно добавить команды форматирования TeX в аннотацию для математических и других символов и греческие буквы.

  1. Добавьте поддерживаемые команды TeX в свою аннотацию. Например, добавьте этот текст:

    \sigma \kappa \mu
    
  2. С аннотацией, выбранной, или с текстовым курсором в аннотации, в Property Inspector, под Appearance, выбирают Enable TeX commands.

    Когда вы щелкаете вне аннотации, команды TeX появляются как символы в аннотации.

Таблица показывает символы TeX, поддержанные в аннотациях Simulink.

Поддерживаемые символы TeX

alpha

beta

gamma

delta

epsilon

zeta

eta

theta

vartheta

iota

kappa

lambda

mu

nu

xi

pi

rho

sigma

varsigma

tau

upsilon

phi

chi

psi

omega

Gamma

Delta

Theta

Lambda

Xi

Pi

Sigma

Upsilon

Phi

Psi

Omega

forall

exists

ast

cong

sim

leq

infty

clubsuit

diamondsuit

heartsuit

spadesuit

leftarrow

uparrow

rightarrow

downarrow

circ

pm

geq

propto

partial

bullet

div

neq

equiv

approx

aleph

Im

Re

otimes

oplus

oslash

cap

cup

supseteq

supset

subseteq

subset

int

in

o

copyright

0

ldots

varpi

times

cdot

vee

wedge

perp

mid

Leftarrow

Rightarrow

Uparrow

Downarrow

prime

nabla

surd

angle

neg

lceil

rceil

lfloor

rfloor

langle

rangle

Объединенные аннотации с блоками и областями

Можно добавить линию между аннотацией и блоком или областью в модели. Это присоединение коннекторов аннотации динамически в обоих концах, так, чтобы они переместили и изменили размер по мере необходимости, чтобы обеспечить связь.

  1. Установите курсор на схему аннотации, где вы хотите, чтобы линия запустилась.

  2. Когда курсор является перекрестием, перетащите линию с блоком или областью, где вы хотите, чтобы линия закончилась.

Совет

Чтобы задать цвет или ширину коннектора аннотации, щелкните правой кнопкой по нему и используйте меню Format.

Скройте аннотацию

По умолчанию все аннотации появляются в модели. Чтобы скрыть аннотацию, сначала сконфигурируйте его для сокрытия путем преобразования его в разметку. Затем во вкладке Format нажмите Show Markup.

Можно сконфигурировать аннотацию так, чтобы можно было скрыть или отобразить ее.

  1. Щелкните правой кнопкой по аннотации.

  2. Из контекстного меню выберите Convert to Markup.

Аннотация разметки имеет голубой фон, независимо от цвета фона, который вы выбираете. Если вы возвращаете аннотацию разметки к регулярной аннотации, аннотация возвращается к цвету фона, который вы выбираете.

Чтобы изменить аннотацию разметки в регулярную аннотацию (та, которую вы не можете скрыть), из контекстного меню аннотации, выбирают Convert to Annotation.

Чтобы скрыть все аннотации разметки, во вкладке Format, нажимают Show Markup.

Чтобы отобразить скрытые аннотации разметки, во вкладке Format, нажимают Show Markup.

Примечание

В иерархии модели - ссылки Show Markup и Hide Markup применяются только к контрольному уровню текущей модели.

Функции обратного вызова аннотации

Можно сопоставить эти функции обратного вызова с аннотациями.

Нажмите Function.  Можно сделать аннотацию интерактивным использованием ссылки. В качестве альтернативы можно сделать аннотацию интерактивной путем добавления коллбэка функции нажатия кнопки. Функцией нажатия кнопки является функция MATLAB, которую вызывает Simulink, когда вы кликаете по аннотации.

Можно добавить коллбэк функции нажатия кнопки программно или в интерактивном режиме. Чтобы создать функцию нажатия кнопки программно, смотрите Simulink.Annotation. Чтобы создать тот в интерактивном режиме, смотрите Партнера Нажимать Function с Аннотацией.

Текст для аннотаций, сопоставленных с функцией нажатия кнопки, появляется в синем.

Функция load.  Simulink вызывает функцию load, когда вы загружаете модель, которая содержит связанную аннотацию. Чтобы сопоставить функцию load с аннотацией, установите LoadFcn свойство аннотации к желаемой функции (см. Simulink.Annotation).

Удалите Функцию.  Удалить функция вызывается, прежде чем вы удалите аннотацию. Чтобы сопоставить удалить функцию с аннотацией, установите DeleteFcn свойство аннотации к желаемой функции (см. Simulink.Annotation).

Сопоставьте Функцию Нажатия кнопки с Аннотацией.  Можно в интерактивном режиме сопоставить функцию нажатия кнопки с аннотацией.

  1. Добавьте аннотацию.

  2. Откройте диалоговое окно Annotation Properties. Щелкните правой кнопкой по аннотации и выберите Properties.

  3. Откройте вкладку ClickFcn. В текстовом поле под ClickFcn введите код MATLAB, который задает функцию нажатия кнопки, и нажмите OK.

Совет

В качестве альтернативы можно использовать текст аннотации в качестве функции нажатия кнопки. Затем в диалоговом окне Annotation Properties установите флажок Use annotation text as click callback.

Выберите и Аннотации Функции нажатия кнопки Редактирования.  Если вы сопоставляете аннотацию с функцией нажатия кнопки, нажатие вызывает функцию вместо того, чтобы выбрать аннотацию. Чтобы выбрать его вместо этого, перетащите рамку выделения вокруг этого. Чтобы отредактировать его, щелкните правой кнопкой по нему и выберите Edit Text или Properties.

Похожие темы

Смотрите также