Комментирование документов в управляемых проектах

Вы просматриваете версию 19.1. Для самой новой информации, перейдите на страницу Комментирование документов в управляемых проектах для версии 21
Applies to Altium Designer versions: 19.1 and 20.0
 

Главная страница: Управляемые проекты и выпуск проекта

Altium Designer в сочетании с сервером управляемых данных поддерживает управляемые проекты, что позволяет распределенным проектным группам совместно работать на проектами, которые централизованно хранятся на этом сервере и управляются им. Комментарии, добавленные к области или объекту в документе схемы или платы управляемого проекта, не изменяют сам документ. Это позволяет комментировать и проверять проект (или его часть) в режиме реального времени, по аналогии с комментированием в Google Docs.

Эта возможность комментирования использует эффективные процессы проверки и совместного проектирования. Благодаря серверному характеру комментариев (они хранятся на сервере и не затрагивают каким-либо образом документы), они становятся неоценимыми в следующих случаях:

  • Вы хотите указать на какие-либо проблемы в документе без физического слияния и получения конфликтов.
  • Вы хотите добавить комментарий, который сразу станет видимым всем, до фиксации рабочей копии.
  • Вам нужен список примечаний для текущего проекта, которые прикреплены областям документа и которые можно закрыть при развитии проекта (аналогично списку текущих задач).
Если вы используете предыдущую версию ПО для проектирования или вошли в версию 1.0 сервера Altium NEXUS Server, будет отображена старая панель Comments.
Перед тем, как начать использовать возможность комментирования, убедитесь, что вы вошли на сервер управляемых данных, открыли управляемый проект и работаете над одним из его документом схемы или его документом платы. Это осуществляется с помощью команды File » Open Managed Project. Для выбора будут доступны только опубликованные вам проекты.
Для получения более подробной информации о поддержке управляемых проектов с точки зрения сервера управляемых данных перейдите на страницу Управляемые проекты.
Для получения более подробной информации о поддержке управляемых проектов с точки зрения сервера управляемых данных перейдите на страницу Управляемые проекты.

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

Для добавления комментария доступны три команды:

  • Place » Comment for Area (Ctrl+Alt+A) – позволяет создать комментарий, который относится к определенной прямоугольной области активного документа.
  • Place » Comment for Point (Ctrl+Alt+P) – позволяет создать комментарий, который относится к определенной точке активного документа.
  • Place » Comment (Ctrl+Alt+C) – позволяет создать комментарий, который относится к одному выделенному компоненту в активном документе.
  • Place » Freehand comment (Ctrl+Alt+R) – позволяет создать комментарий, который относится к пользовательской, нарисованной от руки области документа. Эта команда автоматически распознает содержимое, поэтому если вы рисуете фигуру вокруг компонента, комментарий перейдет к этому компоненту.
Обратите внимание, что команда Place » Comment будет присутствовать только когда в документе схемы или платы выделен компонент. Когда комментарий создан, вокруг компонента образуется прямоугольная линия, описывающая его символ (вместе с выводами) и позиционное обозначение.

► Используйте ссылки для доступа к страницам документации по командам для схем и для плат соответственно.

Запустите одну из этих команд и определите точку, прямоугольник или свободную область для комментария, где это применимо. Будет открыта панель Comments для ввода комментария. Введите комментарий, затем нажмите кнопку  . Комментарий будет зафиксирован и отображен в панели. Комментарий для точки, области или компонента также появится в редакторе компонентов, прикрепленный к точке, области или компоненту соединительной линией.

Пример комментария на дочернем листе схемы управляемого проекта. Панель Comments отражает все комментарии для листа.Пример комментария на дочернем листе схемы управляемого проекта. Панель Comments отражает все комментарии для листа.

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

Использование режима свободного комментария

При использовании функции свободного комментария (Place » Freehand comment, Ctrl+Alt+R), которая позволяет добавлять в документ комментарии рисованием от руки, запись комментария автоматически добавляется в панель Comments, которая будет содержать следующую контекстную информацию:

  • Если вы создаете свободную фигуру вокруг компонента, комментарий будет обозначен строкой <ИмяПользователя> commented on <ПозиционноеОбозначениеКомпонента>.
  • Если вы создаете свободную фигуру где-либо в другом месте документа, комментарий будет обозначен строкой <ИмяПользователя> commented on <ПозиционноеОбозначениеКомпонента>.

Нажмите по записи комментария в панели, чтобы открыть стандартные поля для редактирования комментария (Edit).

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

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

Следующие пункты относятся к работе с комментариями и панелью Comments:

  • При добавлении комментария он сразу становится виден всем другим пользователям, у которых открыт тот же управляемый проект и документ.
  • Панель Comments ведет всю ветвь определенного комментария, и в документе отображается только самый новый комментарий этой ветви.
  • В ветви комментария в панели Comments, самый новый ответ всегда добавляется внизу этой ветви. Если в документе присутствует множество ветвей комментариев, самая новая ветвь отображается в верхней части панели.
  • В панели Comments подсвечивается активный/выбранный комментарий. В редакторе документа, область/точка/компонент, который относится к активному/выбранному комментарию, масштабируется и центрируется в рабочей области (где это применимо). Для комментария для точки, области или компонента также отображается соответствующая соединительная линия.
  • Вы можете перемещать комментарий в редакторе документа, но только с точки зрения того, где будет отображен текст. Изначально заданную точку или область изменить нельзя. Соединительная линия идет от этой точки/области до области текста.
  • Вы можете свернуть комментарий на виде документа щелчком мыши по маленькому треугольнику в верхней левой части текстовой области.
  • Чтобы ответить на комментарий, выберите этот комментарий в панели Comments и нажмите кнопку  . Введите текст в появившемся поле, затем нажмите Reply для фиксации. Чтобы выйти без ответа, нажмите Cancel или щелкните мышью где-либо вне ветви. В последнем случае, появится диалоговое окно с предупреждением, что несохраненные данные будут потеряны. Если вы уверены, что хотите прекратить редактирование, нажмите Yes.
  • Комментарий может быть изменен или удален только через панель, с помощью элементов управления Edit и Delete соответственно, которые появляются при выделении комментария. Обратите внимание, что эти элементы управления будут доступны только для того комментария, который вы создали сами – вы не можете изменять и удалять комментарии, созданные другими пользователями. Если вы изменяете существующий комментарий, введите текст в поле, затем нажмите Update для фиксации. Чтобы выйти без ответа, нажмите Cancel или щелкните мышью где-либо вне ветви. В последнем случае, появится диалоговое окно с предупреждением, что несохраненные данные будут потеряны. Если вы уверены, что хотите прекратить редактирование, нажмите Yes.

Назначение комментария пользователю

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

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

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

На стороне сервера, вошедший пользователь может открыть назначенную ему задачу на странице управления задачами веб-интерфейса сервера – выберите пункт меню Tasks. Администраторы сервера могут видеть, но не изменять, задачи пользователя путем выбора варианта вида All tasks на странице управления задачами.

Разрешение и повторное открытие комментариев

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

Разрешение комментария, по сути, закрывает его, удаляя его из панели и вида документа.Разрешение комментария, по сути, закрывает его, удаляя его из панели и вида документа.

Разрешенные комментарии все еще можно отобразить в панели Comments. Для этого нажмите  в верхней правой части панели и в разделе Comments переключитесь с Active на Resolved. Все комментарии, которые были разрешены ранее, будут отображены в панели. Вы можете восстанавливать комментарии, которые были разрешены. Для этого нажмите кнопку  , связанную с разрешенным комментарием, который вы хотите вернуть. Комментарий будет восстановлен в панели и в редакторе документов.

Доступ к разрешенным ранее комментариям и восстановление (повторное открытие) разрешенного комментария.Доступ к разрешенным ранее комментариям и восстановление (повторное открытие) разрешенного комментария.

Просмотр содержимого

Панель Comments может отображать комментарии, связанные только с активным документом, либо все комментарии из всех документов схем и плат управляемого проекта. Для этого нажмите  в верхней правой части панели и в разделе Context переключайтесь между Project и Document.

Переключение содержимого между просмотром комментариев только для активного документа и всеми комментариями в исходных документах проекта.Переключение содержимого между просмотром комментариев только для активного документа и всеми комментариями в исходных документах проекта.

Привязка комментария к активности

Когда для управляемого комментария запущены активности (как правило, процессы, связанные с проверкой проекта), у вас есть возможность привязывать комментарии к определенной активности. Эта возможность, по сути, помечает комментарий как принадлежащий определенной активности, что может быть очень полезно, если в исходном документе присутствует множество комментариев и определенные комментарии относятся к каким-либо активностям проверки. Эта привязка может быть задана в сессии Web Review или в панели Comments Altium NEXUS.

Когда для управляемого проекта существуют активные процессы, связанные с проверкой, поле справа от записи Activity комментария станет активным – нажмите по нему, чтобы открыть список всех доступных активностей. Выберите запись, чтобы привязать комментарий к этой определенной активности, как показано для области комментариев Web Review ниже.

Выберите, какая активность проверки проекта должна быть связана с комментарием.Выберите, какая активность проверки проекта должна быть связана с комментарием.

Если сессия Web Review была начата из задачи, связанной с активностью, то эта активность будет использоваться по умолчанию при создании комментария в этой сессии Web Review. Вы можете щелкнуть мышью, чтобы изменить это при необходимости. Если сессия Web Review для управляемого проекта была начата по запросу, т.е. вне задачи, то для каждого комментария, размещенного в этой сессии Web Review, по умолчанию будет использоваться запись No activity – щелкните мышью, чтобы выбрать нужную активность.

Связанная с комментарием активность будет отражена из интерфейса Web Review в панели Comments Altium NEXUS, либо если активность задана в панели Comments, она будет отражена в Web Review – обратите внимание, что может понадобиться обновить страницу браузера, чтобы отобразить изменение. Если вы не видите изменений в панели Comments, выйдите и войдите снова в Altium NEXUS.

В Altium NEXUS, назначенные комментариям активности отображаются в панели Comments.
Здесь активности подчеркнуты зеленым для выделения.

Управление отображением комментариев в редакторе

Отображение и внешний вид комментариев управляются из области Document Comments страницы Data Management - Servers диалогового окна Preferences. Представленные элементы управления не зависят от комментариев, отображенных на схеме и на плате. Чтобы отключить отображение комментариев в редакторе документов (оставить их только в панели Comments ) отключите соответствующий параметр Show Comment Threads.

Видимостью комментариев в документе можно также управлять из панели Comments. Для этого нажмите  в верхней правой части панели и переключайтесь между Visible и Hidden в разделе Visibility on canvas.

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

Управление внешним видов комментариев в редакторе через настройки Altium Designer.Управление внешним видов комментариев в редакторе через настройки Altium Designer.

Управление внешним видов комментариев в редакторе через настройки Altium NEXUS.Управление внешним видов комментариев в редакторе через настройки Altium NEXUS.

Примечание

Доступные функциональные возможности зависят от вашего уровня Подписки на ПО Altium Designer.

Content