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

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

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

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

  • Текст

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

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

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

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

Создайте, отредактируйте, и примечания чтения

В Simulink® Toolstrip, на вкладке Modeling, нажимают Notes. Панель Notes открывается. Когда вы перемещаетесь по иерархии, примечания для каждой системы появляются. Если модель не имеет примечаний, панель включает инструкции начать.

Добавить примечания:

  1. В панели Notes нажмите Create a notes file.

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

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

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

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

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

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

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

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

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

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

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

Создайте текстовые аннотации

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

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

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

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

  • Перетащите текст от другого приложения до холста.

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

Когда вы редактируете текстовую аннотацию, вы можете:

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

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

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

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

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

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

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

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

Можно также ввести команды форматирования 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

Создайте аннотации изображений

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

Совет

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

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

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

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

Совет

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

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

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

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

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

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

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

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

Совет

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

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

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

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

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

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

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

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

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

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

Примечание

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

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

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

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

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

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

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

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

  4. Нажмите OK.

В качестве альтернативы можно сопоставить эти функции обратного вызова с текстом или аннотациями изображений.

Функция обратного вызова аннотацииОписание
Нажмите Function

Функцией нажатия кнопки является функция MATLAB, которую вызывает Simulink, когда вы кликаете по аннотации.

Чтобы сопоставить нажатие кнопки функционируют с аннотацией:

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

  2. На вкладке ClickFcn используйте одну из этих опций:

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

    • Используйте текст аннотации в качестве функции нажатия кнопки. Установите флажок Use annotation text as click callback.

  3. Нажмите OK.

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

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

Функция load

Функцией load является функция MATLAB, которую вызывает Simulink, когда вы загружаете модель, которая содержит связанную аннотацию.

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

Удалите функцию

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

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

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

Похожие темы

Для просмотра документации необходимо авторизоваться на сайте