Комментирование документов

При работе с подключенным рабочим пространством проекты Altium Designer позволяют распределенной команде разработчиков совместно работать над проектами, которые хранятся и управляются централизованно. Интерфейс проектирования поддерживает добавление комментариев к различным документам проекта, что упрощает совместную работу. Комментарии, то есть заметки пользователей, можно размещать в документах, а другие пользователи могут отвечать на них.

Панель Comments and Tasks

Размещенные комментарии доступны в реальном времени всем участникам совместной работы (пользователям с общим доступом к документу) и сохраняются на сервере независимо от проекта, никак не изменяя входящие в него документы. Управление комментариями осуществляется через панель Comments and Tasks. При выборе комментария на панели Comments and Tasks система открывает (и при необходимости загружает) связанный с ним документ проекта.

Панель Comments and Tasks позволяет добавлять комментарии к заданной области или точке активного документа проекта рабочего пространства и назначать их участникам рабочего пространства, фактически создавая для них задачи. Панель позволяет всем пользователям, работающим с документом, добавлять и просматривать комментарии, не изменяя сам документ. Эта возможность помогает наладить эффективную совместную работу и особенно полезна, когда нужно указать на проблемы в документе без слияния изменений и возникновения конфликтов. Панель Comments and Tasks можно использовать как список задач, а по мере разработки проекта комментарии можно отмечать как решенные и закрывать. Размещенные комментарии доступны в реальном времени участникам совместной работы — пользователям с общим доступом к документу — и сохраняются в рабочем пространстве независимо от проекта, никак не изменяя входящие в него документы.

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

Подробную информацию о системе комментирования в браузерном интерфейсе рабочего пространства см. в Commenting in the Web Viewer (Рабочее пространство Altium 365, Рабочее пространство Enterprise Server).

Где поддерживаются комментарии

Схема

Комментарий можно добавить к объекту, определенной точке или области в документе схемы.

Печатная плата

Комментарий можно добавить к объекту, определенной точке или области в документе печатной платы (в режиме 2D) — .

Draftsman

Комментарий можно добавить к определенной точке или области в документе Draftsman проекта печатной платы, многоплатной системы или кабельного жгута — .

Схема многоплатной системы

Комментарий можно добавить к объекту или определенной точке в документе схемы многоплатной системы — .

Сборка многоплатной системы

Комментарий можно добавить к определенной точке в документе сборки многоплатной системы — .

Схема соединений и компоновочный чертеж жгута

Комментарий можно добавить к объекту, определенной точке или области в документе схемы соединений или компоновочного чертежа проекта кабельного жгута.

ActiveBOM

Комментарий можно добавить к строке в документе ActiveBOM — .

Доступ к панели комментариев и задач

Открыть панель из проекта рабочего пространства можно следующими способами:

• Нажмите кнопку Panels в правом нижнем углу области проектирования, затем выберите Comments and Tasks.

  Значок рабочего пространства рядом с названием панели в меню в правом нижнем углу области проектирования указывает, что для просмотра данных этой панели требуется подключение к рабочему пространству. Синий значок () означает, что подключение к рабочему пространству установлено. Серый значок () означает, что подключение к рабочему пространству отсутствует, и перед доступом к данным панели вам будет предложено подключиться к рабочему пространству.

• Выберите команду View » Panels » Comments and Tasks в главном меню.

• Дважды щелкните маркер комментария, размещенного в области проектирования.

Добавление комментария без подключения к рабочему пространству

Прежде чем использовать функцию комментирования, убедитесь, что вы подключены к своему рабочему пространству и открыли проект и документ одного из типов, поддерживающих комментарии (схема, 2D-плата, Draftsman или ActiveBOM). Используйте команду File » Open Project, чтобы выбрать проект рабочего пространства из числа проектов, к которым вам предоставлен доступ. На панели Comments and Tasks отображаются подсказки об этих необходимых условиях.

Параметры панели «Комментарии и задачи»

Используйте кнопки в верхней части панели Comments and Tasks, чтобы настроить отображение комментариев на панели и в области редактора, а также указать, следует ли уведомлять упомянутых пользователей.

Итоговый PDF-файл будет содержать информацию о комментариях в проекте: идентификатор комментария, автора, дату и время создания, текст комментария, исполнителя (для задач) и статус (для комментария — если он Resolved; для задачи — статус To Do / In Progress / Resolved). Можно экспортировать все комментарии проекта независимо от времени их добавления либо только комментарии, добавленные между определенными выпусками проекта. Также доступны параметры выбора снимков экрана, которые будут включены в создаваемый PDF-документ. Вместе оба вида снимков показывают, где находится комментарий и к чему он относится (точке, компоненту или области). Если не установить ни один из этих флажков, в документ будут включены только сами комментарии. После настройки нажмите Export , чтобы создать PDF-файл, а в следующем диалоговом окне укажите место сохранения и имя файла (по умолчанию используется имя проекта).

• Entire designs snapshots — включить снимок каждого исходного документа с комментарием за указанный период Period. Нумерованный маркер комментария позволяет наглядно увидеть его расположение в документе.
• Original design screenshots — включить исходный снимок, сделанный при создании комментария (этот же снимок доступен в окне Contextual Commenting при нажатии на маркер комментария в основной области проектирования). Он показывает точку, область или компонент, к которым относится комментарий.

Размещение

Чтобы добавить комментарий в области проектирования объектно-ориентированного графического редактора, например редактора схем, 2D-плат или Draftsman, сначала выполните соответствующую команду. Это можно сделать одним из следующих способов:

• Нажмите кнопку  на панели Comments and Tasks.

• Нажмите  в правом верхнем углу рабочей области проектирования.

• Выберите Place » Comment в главном меню.

• Используйте сочетание клавиш Ctrl+Alt+C.

• Щелкните правой кнопкой мыши в рабочей области проектирования и выберите Comment.

В зависимости от типа документа (см. выше) комментарии можно привязывать к объекту, определенной точке или области активного документа. Команда активирует режим размещения комментария, при этом курсор принимает вид перекрестия с синим кругом, который обнаруживает и подсвечивает объекты для выбора:

• Нажмите на подсвеченный объект, чтобы привязать (закрепить) комментарий к этому объекту.

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

• Нажмите вне объекта и перетащите курсор, чтобы создать прямоугольную выделенную область и привязать к ней комментарий ().

В документе ActiveBOM нажмите на ячейку, чтобы добавить комментарий к соответствующей строке BOM. Щелкните правой кнопкой мыши по строке и выберите команду Comment, чтобы добавить комментарий к этой строке.

После размещения открывается диалог ввода комментария с полем для текста, а для графических документов — также с дополнительной возможностью добавить к комментарию рисунок от руки, если это применимо (). Выберите параметр Assign a task to, чтобы назначить задачу себе или одному из пользователей, упомянутых в комментарии (подробности см. ниже). Нажмите  для подтверждения создания комментария: он будет связан с пронумерованным маркером на документе, а краткая запись о нем появится на панели Comments and Tasks.

Размещение комментария на объекте, упоминание другого зарегистрированного пользователя в комментарии, перемещение маркера комментария и добавление рисунка от руки к комментарию.

Упоминания и назначение задач

Помимо текста, в диалоге ввода комментария можно добавить упоминание любого другого пользователя или роли, зарегистрированных в подключенном рабочем пространстве, введя символ @. Выберите имя или адрес электронной почты из раскрывающегося списка, чтобы добавить ссылку на пользователя (участника рабочего пространства) в комментарий, а также запись Assign a task to — по сути, пользователю будет назначена task. Снимите последний флажок, если не хотите, чтобы комментарий считался назначенным именно этому пользователю. В качестве упоминания можно также добавить группу роли (например, «Инженеры») и, соответственно, входящих в нее пользователей.

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

► Подробнее о предоставлении общего доступа к проекту.

Когда пользователю назначается задача, его изображение или фотография отображается в левом верхнем углу диалога комментария и карточки комментария на панели Comments and Tasks. Кроме того, вместо простого номера, используемого для обычных комментариев, задача получает имя, состоящее из названия проекта и порядкового номера (например, Kame_FMU-1). Это имя также отображается в диалоге комментария и его карточке. Нажмите на него, чтобы открыть страницу Tasks проекта в браузерном интерфейсе рабочего пространства с выбранной задачей в списке задач.

Позиционирование

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

Обратите внимание, что положение комментария также можно задать при его первоначальном размещении, нажав и перетащив курсор в режиме размещения ().

Вставка изображений

Чтобы добавить изображение в комментарий, сначала скопируйте его из Explorer окне или на странице браузера, щелкнув изображение правой кнопкой мыши, чтобы скопировать его в буфер обмена. Чтобы прикрепить изображение, щелкните правой кнопкой мыши и выберите Paste (или используйте сочетание клавиш Ctrl+V ) в самом комментарии (в поле с надписью Add others with @ or paste images). 

Максимальный размер каждого изображения — 2 МБ. После вставки изображения в комментарий щелкните его, чтобы открыть в полном размере, как показано на изображении справа.

Также можно опубликовать комментарий, содержащий только вставленное изображение без текста, как показано ниже.

Рисование

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

Чтобы перейти в режим Freehand Drawing панели Properties, нажмите клавишу Tab , когда активен режим рисования от руки (на это указывает значок  в рабочей области). Эти параметры позволяют отменять и повторять действия с комментариями в раскрывающемся меню Commands, а также изменять ширину, размер и цвет в раскрывающемся меню Properties .

Общие задачи

Общие задачи (задачи, относящиеся к текущему проекту, но не связанные с комментарием или документом проекта) отображаются на панели в отдельной группе под записью проекта. Для общих задач на панели отображаются те же данные и атрибуты (исполнитель, приоритет и т. д.).

Общие задачи отображаются на панели Comments and Tasks.

Щелкните запись общей задачи на панели, чтобы открыть ее диалоговое окно комментариев. Используйте это окно для публикации комментариев (в том числе со вставленными изображениями) к выбранной общей задаче.

Отсоединенные комментарии

Если документ проекта удален или его UniqueID изменился, комментарии к этому документу могут стать «отсоединенными». Эти комментарии по-прежнему доступны в сворачиваемом разделе Detached Comments панели. Щелкните карточку отсоединенного комментария на панели Comments and Tasks, чтобы открыть его диалоговое окно в рабочей области текущего открытого документа.

Работа с комментариями

Комментарии, размещенные в документе проекта, регистрируются как на панели Comments and Tasks (в виде последовательности пронумерованных записей), так и в соответствующем редакторе документа (в виде пронумерованных маркеров). Каждая запись на панели представляет ветку комментариев и содержит сводную информацию: кто и когда разместил комментарий, текст исходного комментария, добавленные упоминания и назначения, а также количество ответов в ветке.

Чтобы открыть ветку комментариев, выберите ее запись на панели Comments and Tasks или щелкните соответствующий маркер в рабочей области. При этом комментарий выделяется в редакторе документа и открывается диалоговое окно комментария, содержащее исходный комментарий и все ответы пользователей. Если выбранный комментарий связан с другим документом проекта, система откроет этот документ (и при необходимости загрузит его).

Навигация по комментариям путем выбора маркеров в рабочей области и записей на панели Comments and Tasks.

Диалоговое окно комментариев

Взаимодействие с размещенным комментарием выполняется через всплывающее диалоговое окно, в котором отображаются все записи выбранной ветки комментариев и доступны команды для предварительного просмотра, ответа, редактирования, закрытия и удаления записи. Это окно открывается при первоначальном размещении комментария или при выборе размещенного комментария на панели Comments and Tasks либо в рабочей области. Нажмите Esc или щелкните в рабочей области, чтобы закрыть диалоговое окно комментария.

Предварительный просмотр

Выберите команду Original Snapshot в исходном комментарии, чтобы увидеть снимок области редактора на момент размещения комментария. Щелкните значок в правом верхнем углу снимка или сам снимок, чтобы открыть полноразмерный предварительный просмотр (чтобы закрыть его, щелкните значок  в правом верхнем углу окна просмотра или само изображение).

Ответ

Введите текст и, при необходимости, упоминание пользователя ('@') в поле Reply, чтобы добавить новую запись в ветку комментариев. Выберите команду Assign a task to, чтобы создать задачу, назначенную пользователю, выбранному в раскрывающемся списке. Нажмите , чтобы подтвердить добавление записи.

Редактирование и удаление

Автор существующего комментария может отредактировать его с помощью команды Edit в меню  комментария. Нажмите кнопку , чтобы подтвердить изменение комментария.

Используйте команду Delete, чтобы удалить выбранный комментарий. Обратите внимание: при удалении исходного комментария (а не ответа) удаляется вся ветка.

Используйте команду Convert to Task, чтобы преобразовать комментарий в задачу, назначенную вам.

Используйте команду Copy Link, чтобы скопировать URL-адрес ветки комментариев. По этой ссылке можно открыть проект в Web Viewer веб-интерфейса рабочего пространства; объект, точка или область комментария будут показаны крупным планом и расположены по центру.

Закрытие

Нажмите кнопку / , чтобы переключить состояние комментария между Resolved и Unresolved (по умолчанию). Закрытый комментарий (отмеченный как завершенный) неактивен и недоступен для редактирования; его запись на панели Comments and Tasks и маркер в документе отображаются серым цветом.

Настройка приоритетов и статусов задач

Если комментарий-задача назначен пользователю, для него можно задать приоритет и статус. При создании задаче сразу присваиваются приоритет Medium и статус To Do, но их можно изменить, щелкнув соответствующий элемент управления в верхней части диалогового окна комментария.

Информация о теге коммита, идентификаторе ревизии выпуска и проверке проекта 

Теги коммитов и идентификаторы ревизий выпусков отображаются при просмотре соответствующих комментариев и задач как на панели Comments and Tasks, так и в диалоговом окне комментариев в Altium Designer.

• Комментарии, созданные в Web Viewer при просмотре снимка проекта для коммита с тегом, будут содержать имя соответствующего тега. Щелкните ссылку с именем тега, чтобы открыть снимок соответствующего коммита в Web Viewer.

• Комментарии, созданные в Web Viewer при просмотре определенного выпуска, будут содержать идентификатор ревизии выпуска. Щелкните ссылку с идентификатором ревизии выпуска, чтобы открыть Manufacturing Portal для этого выпуска.

• Комментарии, созданные в Web Viewer при просмотре снимка Design Review, будут содержать запись о проверке проекта. Нажмите ссылку на проверку проекта, чтобы открыть ее страницу.

Работа с задачами Jira

Если интеграция с Jira включена и настроена для вашего рабочего пространства Altium 365, при размещении комментария будет доступна дополнительная возможность создать задачу в вашем сервисе Atlassian Jira® и связать ее с комментарием. Как и обычные комментарии и связанные с ними задачи, созданные задачи Jira можно просматривать, редактировать и комментировать непосредственно в документах проекта, а также просматривать и выбирать на панели Comments and Tasks.

Размещенный экземпляр задачи Jira синхронизируется с соответствующей задачей в Jira. Двусторонняя синхронизация данных между задачами Jira и задачами рабочего пространства позволяет управлять проектом через Jira совместно с Altium 365.

Создание задачи Jira

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

Выберите Task ID задачи Jira рабочего пространства в диалоговом окне комментария или на панели Comments and Tasks, чтобы открыть эту задачу в Jira на новой вкладке браузера по умолчанию. Task ID рабочего пространства соответствует Issue Key в Jira, а основные параметры Jira, такие как краткое описание, описание, исполнитель и комментарии, сопоставляются между двумя экземплярами. Пользователь рабочего пространства, создавший задачу Jira, становится автором задачи на стороне Jira. Обратите внимание: снимок текущего документа рабочего пространства добавляется в Jira как вложение, если при создании задачи Jira в рабочем пространстве была выбрана опция Attach original snapshot (см. выше).

При размещении задачи Jira в рабочем пространстве создается синхронизированная задача в Jira. Они связываются посредством сопоставления Task ID рабочего пространства с Issue Key Jira.

Помимо параметров, сопоставленных между задачами рабочего пространства и Jira, также синхронизируются настройки Priority и Progress задачи. Например, изменение приоритета задачи рабочего пространства с Medium на High немедленно отразится в задаче на стороне Jira, а изменение статуса выполнения с To Do на In Progress на стороне Jira аналогичным образом изменит статус задачи Jira в рабочем пространстве. Чтобы увидеть обновленные данные, может потребоваться обновить их, нажав кнопку  в верхней части панели Comments and Tasks.

Связывание с задачей Jira

Интеграция Altium 365 с Jira также позволяет связать задачу рабочего пространства с существующей задачей в вашем сервисе Atlassian Jira через режим Jira Issue диалогового окна комментария. Можно связать любую задачу в указанном проекте Jira; после этого она будет синхронизироваться с задачей Jira рабочего пространства.

❯ ❮ Javascript ID: LinkJiraIssue

Разместите комментарий в области документа или на объекте, который хотите связать с существующей задачей Jira, затем выберите режим Jira Issue и опцию Link Issue в диалоговом окне комментария. В раскрывающемся списке Select or search issues выберите задачу Jira (отображается в виде текста Summary), которая будет связана с новым размещенным экземпляром задачи Jira. Начните вводить текст в поле, чтобы найти нужную задачу Jira. В раскрывающемся списке Jira Issue диалогового окна будет отображаться выбранная задача из Jira. При необходимости установите флажок Attach original snapshot, чтобы передать в Jira изображение текущего вида документа. Нажмите кнопку Post, чтобы связать задачу Jira рабочего пространства с выбранной задачей Jira. Новая задача Jira отображается на панели Comments and Tasks и в диалоговом окне комментария, которое будет содержать все существующие (или добавленные) комментарии. Выберите опцию Show all Replies в диалоговом окне, чтобы увидеть полный список.

Связанная задача Jira теперь синхронизируется с задачей Jira рабочего пространства, которая содержит Comments задачи и имеет значения Progress и Priority, заданные в задаче Jira, — In Progress и High в этом примере. Обратите внимание: записи Web links задачи Jira теперь будут указывать, что с этой задачей связана (или повторно связана) задача Jira рабочего пространства Altium 365.

Существующая задача Jira связывается с задачей рабочего пространства путем указания ее Jira Issue в режиме Link Issue диалогового окна комментария рабочего пространства.

Панель To-Do

Хотя подключенное рабочее пространство предоставляет полный набор описанных выше функций комментирования и назначения задач, вы также можете использовать панель To-Do для отслеживания своих задач. На панели To-Do перечислены все задачи To-Do, определенные для активного проекта. Задача To-Do служит напоминанием о действии, которое необходимо выполнить позднее в связи с определенным документом.

Панель To-Do

Содержимое и использование панели To-Do

На панели To-Do могут отображаться два типа задач To-Do для активного проекта:

• Задачи To-Do уровня проекта.
• Задачи To-Do уровня документа — добавленные в текстовый документ проекта.

Для каждой задачи To-Do отображается следующая информация:

• Done — этот флажок позволяет отметить задачу как выполненную.
• Action Item — собственно задача, которую необходимо выполнить.
• Priority — важность задачи (Lowest, Low, Normal (по умолчанию), High, Highest).
• Document — ссылка на исходный документ, в который добавлена задача To-Do уровня документа.
• Owner — имя человека, добавившего задачу, или того, кто должен ее выполнить.
• Category — область проекта, к которой относится задача (например, схемы, правила проектирования, трассировка, ограничения и т. д.).

Добавление задач To-Do уровня проекта

Задачи To-Do уровня проекта добавляются непосредственно на панели. Перед добавлением задач убедитесь, что активный документ в окне редактора является одним из документов того проекта, для которого вы хотите определить задачи To-Do.

Чтобы добавить новую задачу To-Do, щелкните правой кнопкой мыши внутри панели и выберите пункт Add Project To-Do Item в появившемся контекстном меню. Откроется диалоговое окно Edit To-Do Item.

В этом диалоговом окне введите текст, описывающий задачу, которую необходимо выполнить для проекта. Используйте доступные поля диалогового окна, чтобы задать task's Priority, Owner, and Category. Завершив настройку задачи, нажмите OK, чтобы добавить новую задачу на панель.

Добавление задач To-Do уровня документа

Задачи To-Do уровня документа добавляются в текстовый исходный документ (например, файл VHDL, файл ограничений, документ исходного кода встроенного ПО и т. д.). Перед добавлением задач убедитесь, что нужный документ активен в окне редактора и принадлежит проекту, для которого вы сейчас определяете задачи To-Do.

Чтобы добавить новую задачу To-Do, установите текстовый курсор в нужное место документа, щелкните правой кнопкой мыши и выберите пункт Add To-Do Item в появившемся контекстном меню. Откроется диалоговое окно Edit To-Do Item. В этом диалоговом окне введите текст, описывающий задачу, которую необходимо выполнить в документе. Используйте доступные поля диалогового окна, чтобы задать Priority, Owner и Category для задачи (например, форматирование, проверка кода и т. д.). Завершив настройку задачи To-Do, нажмите OK, чтобы закрыть диалоговое окно и вернуться к текущему документу. Запись задачи To-Do появится на панели To-Do, а также в месте, указанном текущим положением текстового курсора. Запись будет оформлена как комментарий (между разделителями комментариев, определенными для этого типа документа) и будет содержать текст задачи и уникальный идентификатор, как показано на изображении ниже.

Контекстное меню

Контекстное меню содержит следующие команды:

• Goto Source — эта команда доступна, когда на панели выбрана задача To-Do уровня документа. Используйте ее, чтобы открыть связанный исходный документ, указанный в поле Document задачи (если он еще не открыт), и сделать его активным в окне редактора. Текстовый курсор будет установлен в начале текста задачи To-Do.
• Add Project To-Do Item — добавить на панель задачу To-Do уровня проекта для активного проекта.
• Edit — изменить выбранную задачу To-Do. Откроется диалоговое окно Edit To-Do Item, в котором можно внести необходимые изменения.
• Delete — удалить выбранную задачу To-Do с панели.
• Show Completed Items — если эта опция включена, на панели будут отображаться только задачи To-Do, отмеченные как выполненные (опция Done включена).
• Report — создать отчет, содержащий все задачи To-Do, которые отображаются на панели в данный момент. После запуска команды откроется диалоговое окно Report Preview, в котором можно настроить, распечатать и экспортировать отчет в различные форматы файлов.

Примечания

• Если на панели определена задача To-Do уровня документа и соответствующий исходный документ активен в окне редактора, весь текст записи этой задачи на панели отображается полужирным шрифтом.
• Двойной щелчок по записи задачи To-Do на панели открывает диалоговое окно Edit To-Do Item, в котором можно изменить описание и параметры задачи.
• Записи на панели можно сортировать по любому столбцу, щелкнув его заголовок. Щелкните один раз для сортировки по возрастанию, повторно — для сортировки по убыванию.
• Прямая фильтрация позволяет быстро перейти к записи задачи To-Do, вводя текст непосредственно на панели. Фильтрацию можно выполнять по любому столбцу данных. Используйте клавиши Right Arrow и Left Arrow для переключения между столбцами фильтрации или щелкните непосредственно по полю нужного столбца. Чтобы воспользоваться этой функцией, щелкните внутри столбца данных и введите первую букву записи, к которой хотите перейти. Будет выбрана первая запись в этом столбце, начинающаяся с введенной буквы, а сама буква будет выделена, показывая, что фильтрация содержимого столбца выполняется по ней.