|
|
| (581 intermediate revisions by 6 users not shown) |
| Line 1: |
Line 1: |
| На этой странице приведена инструкция по работе в пользовательском интерфейсе сервера Svacer.
| | This namespace is visible only to logged-in users. |
| | |
| == Авторизация в пользовательском интерфейсе сервера Svacer ==
| |
| | |
| Для авторизации в пользовательском интерфейсе сервера Svacer введите логин и пароль на странице ввода учётных данных. Учётные данные по умолчанию — admin / admin.
| |
| [[File:Авторизация 01.png|thumb|none|x300px|alt=AutorizationMain|Страница ввода учетных данных]]
| |
| | |
| Если на сервере настроена поддержка протокола LDAP, то войти можно с помощью внешних серверов. Для этого:
| |
| | |
| # На странице ввода учетных данных перейдите на вкладку '''LDAP'''.
| |
| # Выберите LDAP-сервер в списке, если настроено больше одного сервера авторизации.
| |
| # Нажмите кнопку '''Подробности''' для раскрытия подробной информации о сервере и его доступности.
| |
| # Введите логин и пароль.
| |
| | |
| [[File:Авторизация LDAP 02.png|thumb|none|x300px|alt=AutorizationLDAP|Страница входа по протоколу LDAP]]
| |
| | |
| После успешного входа отобразится пользовательский интерфейс сервера Svacer. При этом, если в прошлой сессии пользователь [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбрал проект, его ветку и снимок]] или [[Help:UI manual#Использование фильтров|применил фильтры]], отобразятся эти проект, ветка и фильтры.
| |
| | |
| Описание настроек конфигурации сервера Svacer для поддержки аутентификации по LDAP протоколу приведено по [[LDAP configuration|ссылке]].
| |
| | |
| {{Note|type=info|text=''Чтобы после обновления системы в пользовательском веб-интерфейсе корректно отображались изменения, после авторизации обновите страницу в браузере – нажмите клавишу F5.''}}
| |
| | |
| == Описание основных элементов пользовательского интерфейса ==
| |
| Все страницы пользовательского интерфейса сервера Svacer устроены единообразно и состоят из двух частей:
| |
| # Верхняя панель – отображается на всех страницах пользовательского интерфейса.<br />Содержит:
| |
| #* логотип сервера Svacer;
| |
| #* кнопки меню:
| |
| #** '''Разметка''' – [[Help:UI manual#Работа в режиме просмотра кода|просмотр и разметка найденных маркеров]], а также [[Help:UI manual#Сравнение снимков и маркеров|сравнение снимков или отдельных маркеров]];
| |
| #** '''Код''' – [[Help:UI manual#Работа в режиме разметки|просмотр снимков исходного кода]], связанного с результатами анализатора Svace;
| |
| #** '''Проекты''' – [[Help:UI manual#Управление проектами и группами проектов|управление проектами]] (режим доступен только пользователям с ролью admin);
| |
| #** '''Отчеты''' – [[Help:UI manual#Режим формирования отчетов|формирование отчетов]] на основе хранимой информации;
| |
| #** '''Детекторы''' – [[Help:UI manual#Просмотр детекторов|просмотр списка детекторов]];
| |
| #** '''Статистика''' – [[Help:UI manual#Просмотр статистики|просмотр статистики разметки]] по всем проектам, веткам и снимкам, доступным пользователю;
| |
| #** '''Поиск''' – [[Help:UI manual#Глобальный поиск|глобальный поиск]] снимков, маркеров и комментариев к ним;
| |
| #* [[File:Icon settings.png|x25px]] – кнопка для перехода к [[Help:UI manual#Настройка сервера Svacer|настройке системы]];
| |
| #* [[File:Icon RuEng.png|x25px]] – переключатель языка пользовательского интерфейса;
| |
| #* [[File:Icon question mark.png|x25px]] – кнопка для перехода на страницу документации к системе;
| |
| #* [[File:Icon bell.png|25px]] – кнопка для перехода к [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомлениям]];
| |
| #* [[File:Icon profile.png|x25px]] – кнопка меню пользователя, которое предоставляет следующие функции:
| |
| #** переход к [[Help:UI manual#Настройка профиля пользователя|настройке профиля пользователя]];
| |
| #** [[Help:UI manual#Выход из системы|выход из системы]];
| |
| #** [[Help:UI manual#Просмотр информации о программе|просмотр информации о программе]].
| |
| # Рабочая область – область экрана для просмотра информации и ввода, которая соответствует выбранному режиму работы или странице настроек.
| |
| | |
| :[[File:03 Основные элементы интерфейса – без VSCode.png|thumb|none|upright=3]]
| |
| | |
| == Базовые функции системы ==
| |
| === Просмотр уведомлений в интерфейсе Системы===
| |
| Чтобы посмотреть уведомления, нажмите кнопку [[File:Icon bell.png|25px]] в правом верхнем углу экрана.
| |
| | |
| В правой части экрана отобразится панель со списком уведомлений для авторизованного пользователя:
| |
| | |
| [[File:Notifications new.png|thumbnone|x300px|alt=NotificationList|Панель уведомлений]]
| |
| | |
| Нажмите кнопку [[File:Icon cross 01.png|15px]] для удаления уведомления.
| |
| | |
| Нажмите кнопку '''Очистить''' для удаления всех уведомлений.
| |
| | |
| === Настройка профиля пользователя ===
| |
| Для перехода в профиль выберите пункт '''Профиль''' в меню пользователя в правом верхнем углу экрана:
| |
| [[File:06 Меню пользователя — без VSCode.png|thumb|none|250px|alt=UserMenu|Меню пользователя. Переход к настройке профиля]]
| |
| | |
| В правой части экрана отобразится панель '''Профиль''', на которой можно изменить атрибуты своего профиля (ФИО, контакты), кроме логина, а также [[Help:UI manual#Изменение пароля|поменять пароль]].[[File: 07 Профиль основные параметры.png|thumb|none|x400px|alt=ProfileSetting|Настройки профиля пользователя]]
| |
| | |
| {{Note|type=info|text=''Пользователь LDAP может скорректировать только '''Организации'''. Остальные атрибуты (ФИО, E-mail), а также функция изменения пароля, недоступны.''}}
| |
| | |
| === Изменение пароля ===
| |
| Для изменения пароля:
| |
| :1. Выберите пункт '''Профиль''' в меню пользователя.
| |
| :2. В разделе '''Профиль пользователя''' нажмите на ссылку '''Изменить пароль''':
| |
| :[[File:10_Профиль_изменение пароля.png|thumb|none|450px|Переход к изменению пароля в профиле пользователя]]
| |
| :3. В открывшемся окне:
| |
| ::а) Введите текущий пароль.
| |
| ::б) Дважды введите новый пароль.
| |
| ::в) Нажмите кнопку '''Изменить'''.
| |
| ::[[File:11_Профиль_ввод нового пароля.png|thumb|none|350px|Окно изменения пароля]]
| |
| | |
| === Настройка интерфейса ===
| |
| Для перехода к настройкам выберите пункт '''Настройки интерфейса''' в меню пользователя в правом верхнем углу экрана:
| |
| [[File:187 Меню пользователя интерфейс.png|thumb|none|250px|alt=UserMenu|Меню пользователя. Переход к настройке интерфейса]]
| |
| | |
| В правой части экрана отобразится панель '''Настройки интерфейса''' с тремя группами параметров:
| |
| :1. '''Общие'''. Параметры этой группы позволяют:
| |
| ::а) Выбрать фильтры, которые будут по умолчанию применяться при повторном входе в систему:
| |
| ::*фильтры, установленные в предыдущей сессии (выбрано по умолчанию);
| |
| ::*сохраненный пользовательский фильтр.
| |
| ::б) Включить или выключить (выбрано по умолчанию) замену снимка на последний загруженный в БД Svacer снимок при открытии сохраненного контекста.
| |
| ::Если параметр в состоянии «Выключен», при выборе проекта и ветки открывается последний импортированный снимок.
| |
| ::в) Включить или выключить (выбрано по умолчанию) сохранение вкладок с открытыми файлами в каждом контексте.
| |
| ::г) Включить (выбрано по умолчанию) или выключить сохранение применённой сортировки значений в таблице маркеров при [[Help:UI manual#Выход из системы|выходе из системы]].
| |
| ::д) Включить или выключить (выбрано по умолчанию) механизм генерации PDF-файла на основе HTML при выгрузке отчета с [[Help:UI manual#Таблица маркеров|информацией о маркерах]].
| |
| {{Note|type=warn|text=''Для использования генерации PDF на основе HTML на сервере Svacer должен быть [[Help:Installation#Браузер для PDF-отчетов|установлен браузер Chromium или Google Chrome]].''}}
| |
| :[[File:08 общие настройки интерфейса.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Общие»]]
| |
| :2. '''Навигационная панель'''. Параметры этой группы позволяют:
| |
| ::а) Выбрать отображение по умолчанию данных [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] навигационной панели:
| |
| ::*группировка детекторов по уровням серьезности (выбрано по умолчанию);
| |
| ::*отображение детекторов в виде списка.
| |
| :::Выбранное отображение будет применяться [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] каждый раз после входа в систему.
| |
| ::б) Выбрать отображение по умолчанию данных [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']] навигационной панели:
| |
| ::*только имя файла (выбрано по умолчанию);
| |
| ::*полный путь к файлу.
| |
| ::в) Выбрать способ сортировки в колонке '''Маркеры''' [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']] панели навигации:
| |
| ::*по общему количеству маркеров (выбрано по умолчанию);
| |
| ::*по количеству размеченных маркеров.
| |
| :[[File:08_настройки навигационной панели.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Навигационная панель»]]
| |
| :3. '''Просмотр кода'''. Параметры этой группы позволяют:
| |
| ::а) Включить (выбрано по умолчанию) или выключить использование темной темы (темный фон, светлый текст) при просмотре файлов с исходным кодом.
| |
| ::б) Включить или выключить (выбрано по умолчанию) переиспользование [[Help:UI manual#Вкладка с исходным кодом|вкладки с исходным кодом]] в редакторе кода.
| |
| ::в) Включить или выключить (выбрано по умолчанию) отображение всех элементов трассы маркера по нажатии на ссылку '''Показать трассу''' [[Help:UI manual#Вкладка с исходным кодом|в виджете маркера]].
| |
| ::Если параметр находится в состоянии «Выключен», то будет отображаться только первый элемент трассы.
| |
| ::г) Выбрать отображение виджета относительно строки кода, с которой он связан:
| |
| ::* над строкой кода (выбрано по умолчанию);
| |
| ::* под строкой кода.
| |
| :[[File:08 настройки просмотра кода.png|thumb|none|600px|alt=UserInterfaceSettings|Настройки интерфейса. Группа параметров «Просмотр кода»]]
| |
| :Эти настройки сохраняются для учётной записи пользователя и не сбрасываются при новой сессии.
| |
| :Чтобы сбросить параметры любой группы к значениям по умолчанию, нажмите на ссылку '''Сбросить настройки''' внизу панели '''Настройки интерфейса'''.
| |
| | |
| === Настройка уведомлений ===
| |
| Система может уведомлять пользователей по каналам E-mail и Telegram о следующих типах операций:
| |
| * добавление (при импорте, копировании, клонировании) и удаление снимков;
| |
| * изменение разметки маркеров;
| |
| * добавление комментариев к маркерам.
| |
| | |
| Для перехода к настройкам выберите пункт '''Настройки уведомлений''' в меню пользователя в правом верхнем углу экрана:
| |
| [[File:188 Меню пользователя - уведомления.png|thumb|none|250px|Меню пользователя. Переход к настройке уведомлений]]
| |
| | |
| В правой части экрана отобразится панель '''Настройки уведомлений''' с двумя группами параметров:
| |
| :1. '''Типы уведомлений'''. Параметры этой группы позволяют выбрать канал, по которому будут приходить уведомления, настроить и проверить его. Для этого:
| |
| ::а) Включите опцию '''E-mail''' и (или) '''Telegram chat ID'''.
| |
| ::При выборе уведомления по '''E-mail''' используется адрес электронной почты, указанный [[Help:UI manual#Настройка профиля пользователя|в профиле пользователя]].
| |
| ::б) При выборе уведомления по '''Telegram''' введите '''Telegram chat ID'''.
| |
| ::в) Чтобы проверить подключение к каналу нажмите кнопку '''Проверить'''.
| |
| ::Отправится тестовое сообщение по указанным реквизитам:
| |
| ::[[File:189 Настройки уведомлений.png|thumb|thumb|none|600px|alt=UserInterfaceSettings|Настройки уведомлений]]
| |
| :2. '''Подписки'''. Позволяют выбрать проекты, ветки и события, при возникновении которых будут приходить уведомления. Для этого:
| |
| ::а) Для добавления подписки нажмите кнопку '''Добавить''' и в появившейся строке в раскрывающемся списке выберите проект и/или его ветку.
| |
| ::Чтобы уведомления приходили при изменениях во всех проектах, доступных пользователю, выберите значение '''Все''' в раскрывающемся списке проектов.
| |
| ::[[File:190 Настройки уведомлений. Выбор ветки.png|thumb|thumb|none|600px|alt=UserInterfaceSettings|Настройки уведомлений. Выбор ветки]]
| |
| ::б) Выберите объекты, при изменении которых будут приходить уведомления – установите флажки в столбцах '''Снимки''', '''Разметка''', '''Комментарии'''.
| |
| ::в) Если требуется получать уведомления о разметке и/или комментариях только в маркерах, в которых пользователь принимал участие, установите флажок в столбце '''Участие''' (доступен, только если установлены флажки в столбцах '''Разметка''' и/или '''Комментарии''').
| |
| ::г) Для настройки исключения из подписки на уведомления нажмите кнопку [[File:Icon plus.png|x25px]].
| |
| ::Кнопка примет вид [[File:Icon minus.png|x25px]].
| |
| ::д) Для удаления подписки на уведомления нажмите кнопку [[File:Icon minus.png|x25px]].
| |
| ::По окончании настройки уведомлений нажмите кнопку '''Сохранить'''.
| |
| | |
| === Просмотр информации о программе ===
| |
| Чтобы посмотреть информацию о программе, выберите пункт '''О программе''' в меню пользователя в правом верхнем углу экрана.
| |
| [[File:12_Меню пользователя_о программе — без VSCode.png|thumb|none|250px|Меню пользователя. Переход к просмотру информации о программе]]
| |
| | |
| Откроется окно с информацией о программе
| |
| [[File:13 1 О программме.png|none|thumb|600x600px|Информация о программе]]
| |
| Нажмите на ссылку в строке '''Документация и релизы''' для перехода на страницу документации к системе и ссылкам для скачивания дистрибутивов релизов Svacer.
| |
| | |
| Нажмите на ссылку в строке '''Спецификация OpenAPI''' для открытия страницы Swagger с описанием API методов используемых в Svacer.
| |
| | |
| Нажмите на ссылку '''Telegram''' в строке '''Поддержка и Обратная связь''' для открытия чата с технической поддержкой.
| |
| | |
| Нажмите на ссылку '''Email''' в строке '''Поддержка и обратная связь''' для отправки сообщения в службу технической поддержки по электронной почте.
| |
| | |
| == Выбор контекста (проекта, ветки и снимка) ==
| |
| Для работы [[Help:UI manual#Работа в режиме разметки|в режиме разметки]] или [[Help:UI manual#Работа в режиме просмотра кода|режиме просмотра кода]] требуется выбрать проект, ветку и снимок с результатами работы анализатора Svace, а в [[Help:UI manual#Режим формирования отчетов|разделе '''Отчёты''']] – проект и ветку.
| |
| | |
| При необходимости список проектов можно отфильтровать по группе проектов. Это можно сделать в блоке, который расположен под [[Help:UI manual#Описание основных элементов пользовательского интерфейса|верхней панелью]].
| |
| | |
| [[File:14_Выбор проекта, верки, снимка.png|800px]]
| |
| | |
| По умолчанию после выбора проекта автоматически выбирается ветка master и последний импортированный снимок, если [[Help:UI manual#Настройка интерфейса|параметр '''При открытии сохраненного контекста заменить снимок на последний загруженный''']] находится в состоянии '''Выключен'''. Если master отсутствует, то ветку нужно выбрать вручную.
| |
| | |
| == Работа в режиме разметки ==
| |
| Режим разметки предоставляет следующий набор элементов управления:
| |
| :1. Навигационная панель:
| |
| :* [[Help:UI manual#Вкладка «Детекторы»|вкладка '''Детекторы''']];
| |
| :* [[Help:UI manual#Вкладка «Файлы»|вкладка '''Файлы''']].
| |
| :Эту панель можно скрыть. Для этого нажмите кнопку [[File:Button Скрыть навигацию.png|x25px]] в правом верхнем её углу. Чтобы панель раскрыть, нажмите кнопку [[File:Button Паказать навигацию.png|x25px]].
| |
| :2. Центральная панель:
| |
| :* [[Help:UI manual#Вкладка «Информация о снимке»|вкладка '''Информация о снимке''']] – открывается по нажатии кнопки [[File:Icon Information.png|25x25px]];
| |
| :* одна или несколько [[Help:UI manual#Вкладка с исходным кодом|вкладок с исходным кодом''']] (отображаются после выбора файлов в таблице маркеров или навигационной панели);
| |
| :* [[Help:UI manual#Таблица маркеров|таблица маркеров]];
| |
| :3. [[Help:UI manual#Функции правой панели|Правая панель]] с информацией о маркере.
| |
| :Эту панель можно скрыть. Для этого нажмите кнопку [[File:Button Паказать навигацию.png|x25px]] в левом верхнем её углу. Чтобы панель раскрыть, нажмите кнопку [[File:Button Скрыть навигацию.png|x25px]].
| |
| | |
| [[File:96 Режим разметки. Набор элементов управления.png|800px|thumb|none|Режим разметки. Набор элементов управления]]
| |
| | |
| === Функции навигационной панели ===
| |
| ==== Вкладка «Детекторы» ====
| |
| На этой вкладке отображается список детекторов Svace, которые сработали в выбранном снимке.
| |
| | |
| Серьезность (критичность) детектора обозначена цветом:
| |
| * красный – наивысшая серьезность (CRITICAL);
| |
| * желтый – высокая серьезность (MAJOR);
| |
| * белый – обычная серьезность (NORMAL, MINOR, UNDEFINED).
| |
| | |
| На вкладке '''Детекторы''' пользователю доступны следующие функции:
| |
| :1. Поиск по детекторам и файлам.
| |
| :2. Выгрузка списка отображаемых на панели детекторов и маркеров в файл формата .csv – для этого нажмите кнопку [[File:Button Скачать CSV.png|x25px]]
| |
| :3. Отображение данных в виде списка – для этого нажмите кнопку [[File:icon_list.png|x25px]].
| |
| :4. Группировка детекторов по уровням серьезности (по умолчанию) – для этого нажмите кнопку [[File:icon_tree.png|x25px]].
| |
| <gallery mode="packed" heights="250px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
| |
| 16_Детекторы_список.png|Вкладка '''Детекторы''' с данными в виде списка
| |
| 15_Детекторы_группировка.png|Вкладка '''Детекторы''' с группировкой по уровням серьезности
| |
| </gallery>
| |
| <br clear=all />
| |
| :5. Сворачивание и разворачивание дерева детекторов (доступно при любом виде группировки):
| |
| ::а) Для сворачивание нажмите кнопку [[File:Button Скрыть таблицу.png|x25px]].
| |
| ::Список детекторов свернется: при примененной группировке отобразятся группы детекторов; при отображении данных в виде списка отобразится список детекторов; кнопка примет вид [[File:Button Показать таблицу.png|x25px]].
| |
| ::б) Для разворачивания нажмите кнопку [[File:Button Показать таблицу.png|x25px]].
| |
| ::Список детекторов развернется полностью: при примененной группировке отобразятся группы детекторов с раскрытыми списками детекторов и файлов, в которых они найдены; при отображении данных в виде списка отобразится список детекторов с раскрытыми списками файлов, в которых они найдены; кнопка примет вид [[File:Button Скрыть таблицу.png|x25px]].
| |
| :6. Отображение списка маркеров в файлах, в которых сработал детектор – для этого нажмите кнопку [[File:icon_uncover.png|x15px]] в левой части его имени.
| |
| :[[File:checker_uncover.png|thumb|none|320px|Список маркеров, найденных детектором]]
| |
| :7. [[Help:UI manual#Блокировка разметки|Блокировка всех маркеров]], найденных детектором, для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] справа от названия детектора (отображается при наведении курсора).
| |
| :8. Применение фильтра по детектору [[Help:UI manual#Таблица маркеров|в таблице маркеров]] – для этого нажмите на название детектора или название файла в раскрывающемся списке маркеров детектора.
| |
| :9. Применение фильтра по серьезности [[Help:UI manual#Таблица маркеров|в таблице маркеров]] – для этого нажмите на название группы серьезности.
| |
| :10. Отмена фильтров по серьезности, детекторам и файлам – для этого нажмите кнопку [[File:icon_return.png|x25px]].
| |
| :11. Отображение [[Help:UI manual#Вкладка с исходным кодом|на вкладке исходного кода]] содержимого файла, места и содержания маркера, а также подробной информации о маркере [[Help:UI manual#Функции правой панели|на правой панели]] – для этого нажмите на маркер.
| |
| :12. Просмотр фрагмента кода в режиме предпросмотра – для этого нажмите кнопку [[File:icon_preview_code.png|x25px]].
| |
| | |
| ==== Вкладка «Файлы» ====
| |
| На этой вкладке отображается список файлов, в которых найдены маркеры.
| |
| | |
| [[File:17 Файлы.png|thumb|none|300px|Вкладка '''Файлы''']]
| |
| | |
| Для каждого файла отображаются:
| |
| * имя;
| |
| * количество найденных маркеров (предупреждений);
| |
| * количество размеченных маркеров;
| |
| * кнопки [[File:Icon plus.png|x25px]] или [[File:Icon minus.png|x25px]] (если применена фильтрация по файлам).
| |
| | |
| На вкладке '''Файлы''' пользователю доступны следующие функции:
| |
| :1. Просмотр на [[Help:UI manual#Вкладка с исходным кодом|вкладке с исходным кодом]]: содержимого файла, места и содержания маркера, а также подробной информации о маркере [[Help:UI manual#Функции правой панели|на правой панели]] – без включения фильтрации по этому файлу. Для этого нажмите на имя файла.
| |
| :2. Применение фильтра по файлам [[Help:UI manual#Таблица маркеров|в таблице маркеров]] – для этого нажмите кнопку [[File:Icon plus.png|x25px]] в одной или нескольких строках.
| |
| :Фильтр применится, кнопка [[File:Icon plus.png|x25px]] в списке файлов поменяется на [[File:Icon minus.png|x25px]].
| |
| :3. Исключение файла из фильтра по файлам [[Help:UI manual#Таблица маркеров|в таблице маркеров]] – для этого нажмите кнопку [[File:Icon minus.png|x25px]] в строке файла.
| |
| :4. Отмена фильтрации [[Help:UI manual#Таблица маркеров|в таблице маркеров]] для всех выбранных файлов – для этого нажмите кнопку [[File:Icon minus 3.png|x25px]] или кнопку [[File:icon_return.png|x25px]] [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']].
| |
| :5. [[Help:UI manual#Блокировка разметки|Блокировка всех маркеров]] в файле для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] справа от названия файла (отображается при наведении курсора).
| |
| :6. Поиск по имени/пути файла в поле '''Поиск по полному пути'''. Поддерживается поиск с использованием [[Help:UI manual#Использование регулярных выражений|регулярных выражений]].
| |
| :7. Сортировка файлов по количеству маркеров – для этого нажмите кнопку [[File:Icon-expand-all.png|x25px]]
| |
| :8. Настройка отображения файлов и сортировки в колонке '''Маркеры''' на вкладке '''Файлы''' – для этого нажмите кнопку [[File:icon_gear.png|x25px]] и поменяйте настройки.
| |
| :9. Выгрузка списка отображаемых на панели файлов в файл формата .csv – для этого нажмите кнопку [[File:button_Скачать CSV.png|25px]]
| |
| | |
| :[[File:18 Временная настройка панели навигации.png|thumb|none|800px|Настройка отображения файлов и сортировки полей]]
| |
| | |
| === Функции центральной панели ===
| |
| ==== Вкладка «Информация о снимке» ====
| |
| На этой вкладке отображается информация о выбранном снимке.
| |
| | |
| [[File:19 Информация о снимке.png|thumb|left|600px|Вкладка '''Информация о снимке''']]
| |
| <br clear=all />
| |
| На вкладке '''Информация о снимке''' пользователю доступны следующие функции:
| |
| :1. Просмотр подробной информации о снимке во всплывающем окне – для этого нажмите кнопку '''Просмотреть JSON'''.
| |
| :2. Экспорт [[Help:UI manual#Экспорт|исходного кода, снимков и разметки]] – для этого нажмите кнопку '''Экспорт''' и выберите подходящий вариант.
| |
| :3. [[Help:UI manual#Импорт разметки|Импорт разметки]] – для этого нажмите кнопку '''Импорт''' и выберите подходящий вариант.
| |
| :4. Переход к более продвинутой навигации по исходному коду с подсветкой маркеров во встроенном Web-IDE Theia – для этого нажмите кнопку '''Открыть в IDE''' .
| |
| :{{Note|type=warn|text=''Функциональность является экспериментальной, доступна при наличии проектного доступа '''Экспорт снимков''' и запуске веб-приложения Svacer по протоколу HTTPS или на локальном хосте. Список доступных IDE определяется при инсталляции. Если доступна только одна IDE, то раскрывающийся список отсутствует, а IDE открывается сразу по нажатию кнопки '''Открыть в IDE'''. Если функциональность недоступна, кнопка '''Открыть в IDE''' неактивна и отображается иконка'' [[File:Icon attention.png|23x23px]]''.''}}
| |
| :5. Просмотр списка приложенных файлов — по нажатии кнопки '''Показать''', но только при наличии приложенных файлов.
| |
| :6. Скрытие списка приложенных файлов (возможно только при наличии приложенных файлов) – для этого нажмите на ссылку '''Скрыть'''.
| |
| :7. Удаление приложенного файла (возможно только при наличии приложенных файлов) — для этого нажмите кнопку [[File:icon_delete.png|x25px]].
| |
| :8. Просмотр пользовательских полей, которые пользователь указал при импорте – доступен по нажатии кнопки '''Показать''', но только при наличии этих полей.
| |
| :9. Просмотр параметров анализа во всплывающем окне – для этого нажмите кнопку '''Показать''' в строке '''Параметры анализа'''.
| |
| :10. Экспорт параметров анализа в формате .txt – для этого нажмите кнопку '''Скачать''' в строке '''Параметры анализа'''.
| |
| :11. [[Help:UI manual#Работа с таблицей статистики|Просмотр таблицы статистики]] – для этого нажмите кнопку '''Показать''' в строке '''Статистика по детекторам'''.
| |
| :Информация в таблице сгруппирована по параметрам детекторов, найденным маркерам и статусу их разметки.
| |
| | |
| ==== Вкладка с исходным кодом ====
| |
| Вкладка открывается только после выбора файла [[Help:UI manual#Вкладка «Детекторы»|на вкладке '''Детекторы''']] или [[Help:UI manual#Вкладка «Файлы»|'''Файлы''']], а также [[Help:UI manual#Таблица маркеров|в таблице маркеров]]. Одновременно может быть открыто несколько вкладок с исходным кодом, если выключена [[Help:UI manual#Настройка профиля пользователя|настройка '''Переиспользование вкладки в редакторе кода''']].
| |
| | |
| В верхней части вкладки отображается полный путь к файлу. Если в строке кода установлен курсор, то в нижнем правом углу вкладки отображается его позиция:
| |
| [[File:20 Исходный код.png|thumb|none|600px|Полный путь к файлу и позиционирование курсора]]
| |
| | |
| На вкладке с исходным кодом пользователю доступны следующие функции:
| |
| :1. Отображение кода на весь экран – для этого нажмите кнопку [[File:Icon expand.png|23x23px]] или дважды кликните на вкладку файла.
| |
| :
| |
| :Для возврата к обычному отображению нажмите кнопку [[File:Icon minimize.png|24x24px]] или дважды кликните на вкладку файла.
| |
| :2. Переход к предыдущей или следующей строке, в которую пользователь устанавливал курсор, – для этого используйте кнопки [[File:Button left.png|23x23px]] и [[File:Button right.png]] или сочетания клавиш '''Ctrl + <''' и '''Ctrl + >'''.
| |
| :3. Добавление комментария к строке кода – можно сделать двумя способами:
| |
| ::а) Нажмите кнопку [[File:Button Comment Add.png|x25px]] в левой части строки, рядом с её номером (отображается только если в строке установлен курсор) и введите комментарий.
| |
| ::ИЛИ
| |
| ::б) Нажмите правой кнопкой мыши на строку и выберите пункт '''Добавить комментарий'''. Этим способом можно добавить несколько комментариев к одной строке.
| |
| :4. Просмотр комментария к строке – можно сделать двумя способами:
| |
| ::а) Нажмите кнопку [[File:Button Comment view.png|x25px]] в левой части строки, рядом с её номером.
| |
| ::ИЛИ
| |
| ::б) Нажмите кнопку [[File:Button Comment view.png|x25px]] справа и выберите в списке строку комментария.
| |
| ::Отобразится виджет комментария, в котором доступны следующие функции:
| |
| ::*добавление дополнительного комментария к этой строке кода по нажатии кнопки [[File:Button Comment Add.png|x25px]];
| |
| ::*редактирование текста комментария по нажатии кнопки [[File:icon_edit3.png|x25px]];
| |
| ::*удаление комментария по нажатии кнопки [[File:icon_delete 2.png|x25px]].
| |
| :[[File:118 Виджет комментария к строке кода.png|thumb|none|600px|Виджет комментария к строке кода]]
| |
| :5. Просмотр и открытие комментариев из списка всех комментариев в коде – для этого нажмите кнопку [[File:Button Comment view.png|x25px]] справа.
| |
| :6. Отображение всех комментариев в коде – для этого нажмите кнопку [[File:Button_Comment_view_all.png|x25px]] справа.
| |
| :7. Скрытие всех комментариев в коде – для этого нажмите кнопку [[File:Button_Comment_hide_all.png|x25px]] справа.
| |
| :8. Отображение всех маркеров – для этого нажмите кнопку [[File:Icon view marks.png|x25px]].
| |
| :9. Скрытие всех маркеров – для этого нажмите кнопку [[File:Icon hide marks.png|x25px]].
| |
| :10. Просмотр и открытие маркеров из списка всех маркеров в данном файле – для этого нажмите кнопку [[File:Icon list 2.png|x25px]].
| |
| | |
| :[[File:21 Исходный код Отображение списка маркеров.png|thumb|none|300px|right|Cписок маркеров в файле]]
| |
| | |
| :11. Возврат к исходному маркеру (например, если был выбран другой связанный маркер на вкладке '''Трасса''' [[Help:UI manual#Функции правой панели|правой панели]]) – для этого нажмите кнопку [[File:Icon target.png|x25px]] в верхней части виджета элементов трассы.
| |
| :12. [[Help:UI manual#Разметка маркера|Разметка маркера]] – установите '''Статус''', '''Серьезность''' и '''Действия''' в верхней части блока с информацией о маркере.
| |
| :13. Отображение виджетов элементов трассы для строки кода – нажмите ссылку '''Показать трассу''' (доступна, если все виджеты элементов трассы скрыты).
| |
| ::Для последовательного перехода к другим элементам трассы воспользуйтесь кнопками [[File:Button up.png|x25px]] и [[File:Button down.png|x25px]].
| |
| ::{{Note|type=info|text=''Отображение только первого элемента трассы или всех элементов трассы маркера по нажатии кнопки '''Показать трассу''' настраивается с помощью [[Help:UI manual#Настройка интерфейса|параметра '''Показывать всю трассу маркера''']].''}}
| |
| ::[[File:97 Блок информации о элементе трассы.png|thumb|none|600px|Виджет элемента трассы]]
| |
| :14. Скрытие виджетов элементов трассы для строки кода – нажмите ссылку '''Скрыть трассу''' (доступна, если хотя бы один виджет элемента трассы отображается).
| |
| ::В этом случае все открытые виджеты элементов трассы маркера скрываются.
| |
| :15. Переход к строке, в которой объявлена/определена переменная – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Перейти к объявлению / Перейти к определению'''.
| |
| :{{Note|type=info|text=''Если для выделенного элемента кода нет объявления или определения, то отобразится сообщение: [[File:150 Объявление не найдено.png|247x247px]] или [[File:151 Определение не найдено.png|254x254px]].''}}
| |
| | |
| :16. Просмотр ссылок на панели внизу экрана – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Найти ссылки'''. На этой панели отображается иерархический список файлов с номерами строк, в которых найдены ссылки:
| |
| :[[File:Исходный_код_Референсы.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]
| |
| | |
| :* Чтобы перейти к строке кода, на которую найдена ссылка, нажмите на ссылку с номером строки на панели [1].
| |
| :* Чтобы посмотреть фрагмент кода, на который найдена ссылка, в режиме предпросмотра, нажмите кнопку [[File:icon_preview_code.png|x25px]] [2].
| |
| :{{Note|type=info|text=''Если для выделенного элемента кода нет ссылок, то отобразится сообщение: [[File:152 Ссылки не найдены.png|213x213px]].''}}
| |
| | |
| :17. Переход к просмотру выбранного файла [[Help:UI manual#Работа в режиме просмотра кода|в режиме просмотра кода]] – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Открыть в режиме Код'''.
| |
| :18. Копирование ссылки на строку кода в буфер обмена – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Копировать прямую ссылку'''.
| |
| ::При переходе по этой ссылке будет открываться файл в режиме разметки с курсором на той строке кода, для которой была скопирована ссылка.
| |
| :19. Увеличение и уменьшение размера шрифта кода вместе с отображаемыми виджетами – нажмите правую кнопку мыши на любой строке исходного кода и выберите пункт '''Уменьшить''' или '''Увеличить''', либо установите курсор в любую строку и нажмите сочетание клавиш '''Ctrl + Alt + -''' или '''Ctrl + Alt + ='''
| |
| :20. Копирование строки кода – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Copy'''.
| |
| :21. Вызов командной строки – нажмите правую кнопку мыши на строке исходного кода и выберите пункт '''Command Palette'''.
| |
| :[[File:25 Исходный код Вызов командной строки.png|thumb|none|600px|Командная строка]]
| |
| | |
| ==== Таблица маркеров ====
| |
| Для раскрытия таблицы маркеров нажмите кнопку [[File:Button Показать таблицу.png|x25px]] в верхней части [[Help:UI manual#Функции центральной панели|центральной панели]], а для её скрытия – [[File:Button Скрыть таблицу.png|x25px]].
| |
| | |
| В верхней части таблицы находится панель, которая содержит:
| |
| * [[File:Field Детектор.png|x25px]] – поле с информацией [[Help:UI manual#Использование фильтров|о примененных фильтрах]]: как назначенных [[Help:UI manual#Функции навигационной панели|в навигационной панели]], так и с помощью [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] и запросов;
| |
| * <span id="dwl_pdf"></span>кнопка [[File:Icon download.png|x25px]] – выгрузка маркеров в файл формата .csv или .pdf: только для [[Help:UI manual#choice|выбранных]] или всех отображаемых маркеров, если ничего не выбрано. Отчет в формате .pdf может быть сгенерирован на основе HTML, так и существующим (нативным) способом. В PDF-отчете, сгенерированном на основе HTML, усовершенствованы стили, доработан титульный лист, актуализирован набор параметров для выгружаемых маркеров и пр.;
| |
| :{{Note|type=warn|text='''''Примечания:'''''
| |
| :* ''если в таблице не отображаются маркеры из-за примененных пользовательских фильтров, то в сгенерированном PDF-отчете будет указано «Нет маркеров (применены фильтры)»;''
| |
| :* ''для использования механизма генерации PDF-отчёта на основе HTML должна быть включена [[Help:UI manual#Настройка интерфейса|одноименная настройка]];''
| |
| :* ''генерация PDF-отчета на основе HTML может занимать больше времени, чем нативная генерация;''
| |
| :* ''спецсимволы (иконки), добавленные в комментариях к маркерам, не отображаются в выгруженном PDF-отчете.''}}
| |
| | |
| * кнопка [[File:Icon edit.png|x25px]] – переход [[Help:UI manual#Групповая разметка маркеров|к групповой разметке]] выбранных маркеров (доступна, если выбраны маркеры в таблице);
| |
| * кнопка [[File:Button_Comment_Add.png|x25px]] – переход к [[Help:UI manual#Добавление общего комментария к нескольким маркерам|добавлению общего комментария к нескольким выбранным маркерам]].
| |
| | |
| :[[File:26 Таблица маркеров.png|thumb|none|800px|Таблица маркеров с примененными фильтрами]]
| |
| | |
| В таблице маркеров пользователю доступны следующие функции:
| |
| :1. Сортировка по значениям столбцов.
| |
| :2. <span id="choice"></span>Выбор маркеров для [[Help:UI manual#dwl pdf|выгрузки отчета]], [[Help:UI manual#Групповая разметка маркеров|групповой разметки]] или [[Help:UI manual#Добавление общего комментария к нескольким маркерам|добавления общего комментария к нескольким маркерам]] – для этого установите флажок в строке маркера.
| |
| :3. Просмотр подробной информации о маркере [[Help:UI manual#Функции правой панели|в правой панели]] и его места и содержания [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] – для этого дважды кликните на строку маркера или нажмите на имя файла в столбце '''Файл'''. Также для выбора можно использовать клавиши ↑ и ↓ – для перемещения по строкам, и Enter – для подтверждения выбора.
| |
| :4. Копирование детальной информации о маркере в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Копировать'''.
| |
| :При переходе по этой ссылке будет открываться список маркеров в режиме разметки с открытым маркером (в правой панели и на вкладке с исходным кодом), для которого была скопирована ссылка.
| |
| :5. Копирование ссылки на маркер в буфер обмена – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Копировать ссылку на маркер'''.
| |
| :6. Переход к [[Help:UI manual#Сравнение маркеров|сравнению одного маркера с другим]] – для этого нажмите правой кнопкой мыши на маркер и выберите пункт '''Сравнить с ...'''
| |
| | |
| === Функции правой панели ===
| |
| Эта панель предоставляет подробную информацию о маркере и его [[Help:UI manual#Разметка маркера|разметке]]:
| |
| * статус [[Help:UI manual#Блокировка разметки|блокировки разметки]];
| |
| * статус [[Help:UI manual#Разметка маркера|разметки, его серьезность и требуемое действие]];
| |
| * автор последней разметки и прочее;
| |
| [[File:27 Правая панель.png|thumb|none|upright=4|Правая панель]]
| |
| | |
| На правой панели пользователю доступны следующие функции:
| |
| :1. Копирование ссылки на маркер – для этого нажмите кнопку [[File:Icon copy link.png|x25px]].
| |
| :2. [[Help:UI manual#Блокировка разметки|Блокировка маркера]] для разметки другими пользователями – для этого нажмите кнопку [[File:icon_unlocked.png|x25px]] в верхней части правой панели.
| |
| :3. [[Help:UI manual#Разметка маркера|Разметка маркера]] – для этого установите '''Статус''', '''Серьезность''' и '''Действие''' в верхней части правой панели.
| |
| :4. Просмотр истории разметки со связанными комментариями – для этого нажмите кнопку [[File:Icon history.png|x25px]] в верхней части правой панели.
| |
| :[[File:28 История изменения маркера.png|thumb|none|upright=2.5|Пример истории изменения разметки маркера]]
| |
| | |
| :5. Отображение маркера [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] нажмите кнопку с именем файла и номером строки в верхней части правой панели.
| |
| :6. Отображение элемента трассы [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]] – для этого нажмите на ссылку с именем файла и номером строки на вкладке '''Трасса''' [1].
| |
| :7. Отображение кода, который соответствует строке трассы, в отдельном окне в режиме предпросмотра – для этого на вкладке '''Трасса''' нажмите кнопку [[File:Icon preview code.png|x25px]] рядом с именем файла и номером строки [2].
| |
| :[[File:31 Предпросмотр кода.png|thumb|none|upright=2.5|Элементы управления для работы с элементом трассы]]
| |
| :8. Просмотр и добавление комментариев к маркеру на вкладке '''Комментарии'''.
| |
| :Комментарии для каждого маркера уникальны. Добавление одинаковых комментариев недоступно.
| |
| :Редактор комментариев поддерживает синтаксис Markdown.
| |
| :Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
| |
| :9. Редактирование и удаление комментариев на вкладке '''Комментарии''' с помощью кнопок [[File:Icon edit2.png|x25px]] и [[File:Icon delete.png|x25px]].
| |
| :Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флажок '''Обязательный комментарий при разметке''', то удаление связанного с разметкой комментария недоступно. Его можно только отредактировать.
| |
| :[[File:32 Комментарии.png|thumb|none|upright=1.3|Вкладка '''Комментарии''']]
| |
| :{{Note|type=info|text='''''Примечания''':''
| |
| :* ''Пользователь может отредактировать и удалить только свои комментарии. Пользователю с доступом '''Изменение любых комментариев''' доступно редактирование и удаление комментариев всех пользователей. Если такой пользователь внёс изменения, то изначальный автор теряет возможность изменять свой комментарий (если у него нет доступа '''Изменение любых комментариев'''), так как авторство передаётся пользователю, который последним внёс изменения.''
| |
| :* ''Для отредактированного комментария отображается слово '''изменено''', при наведении курсора на которое отображается сообщение с логином пользователя, изменившего комментарий, и датой редактирования. Текст несохраненного комментария в поле добавления комментария не пропадает при переключении на другой маркер.''
| |
| :* ''Если открыт режим редактирования комментария, то при переключении на другой маркер режим редактирования закрывается и изменения не сохраняются.''}}
| |
| :10. Ввод, просмотр и редактирования комментария в отдельном диалоговом окне – для этого нажмите кнопку [[File:Button Comment Zoom.png|x25px]] рядом с полем ввода нового комментария или в поле существующего комментария.
| |
| :[[File:120 Окно создания, просмотра и редактирования комментария в отдельном диалоговом окне.png|thumb|none|upright=2|Окно создания, просмотра и редактирования комментария в отдельном диалоговом окне]]
| |
| :11. Просмотр подробной информации на вкладке '''Подробности'''. Содержит два блока:
| |
| :* информация о сработавшем детекторе: серьезность и надежность, а также связанные с ним коды CWE, которые содержат ссылки на описание дефектов безопасности на сайте [https://cwe.mitre.org cwe.mitre.org];
| |
| :* информацией о маркере: текстовые метки маркера, названия снимка и функции, инструмент, язык, текстовое описание и степень доверия, а также кнопки для перехода к просмотру истории маркера и запуску хуков.
| |
| ::{{Note|type=info|text=''Svace, начиная с версии 4.0, для некоторых языков поставляется с моделью искусственного интеллекта, которая предсказывает истинность срабатывания маркера на основе предупреждений и собранных метрик. Это значение в Svacer отображается в параметре '''Степень доверия'''.''}}
| |
| ::По нажатии на иконку [[File:icon_question_mark2.png|x25px]] справа от названия детектора отображается дополнительная информация о нём. Иконка не отображается, если дополнительная информация отсутствует.
| |
| :[[File:33 Подробная информация о маркере.png|thumb|none|upright=2|Вкладка '''Подробности''']]
| |
| :[[File:121 Окно с дополнительной информацией о детекторе.png|thumb|none|upright=2|Окно с дополнительной информацией о детекторе]]
| |
| | |
| :12. Просмотр истории обнаружения маркера в снимках данной ветки проекта – для этого на вкладке '''Подробности''' нажмите кнопку '''Показать''' в блоке информации о маркере в строке '''История'''.
| |
| :В окне просмотра истории доступна сортировка записей.
| |
| :[[File:35 История маркера.png|thumb|none|upright=2.5|Пример истории маркера]]
| |
| :13. Запуск хуков (скриптов) – для этого нажмите кнопку '''Запустить''' на вкладке '''Подробности''' и в раскрывающемся списке доступных хуков выберите тот, который требуется запустить.
| |
| <br />
| |
| | |
| === Использование фильтров ===
| |
| ==== Общая информация ====
| |
| Настройка и использование фильтров доступны [[Help:UI manual#Работа в режиме разметки|в режиме разметки]].
| |
| | |
| Существует пять видов фильтров:
| |
| | |
| # Фильтры [[Help:UI manual#Функции навигационной панели|навигационной панели]] [1]: детекторы, файлы или серьезность.
| |
| # Доступные для разметки – позволяют отобразить только маркеры, которые доступны пользователю для разметки, т. е. при использовании этого фильтра в списке не будут отображаться маркеры, заблокированные другими пользователями. Фильтр применяется по нажатии кнопки [[File:Icon view2.png|x25px]] [2] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
| |
| # Размеченный – позволяют отобразить только размеченные маркеры. Фильтр применяется по нажатии кнопки [[File:Icon view.png|x25px]] [3] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
| |
| # [[Help:UI manual#Настройка и использование пользовательских фильтров|Пользовательские фильтры]] – доступны по нажатии кнопки [[File:Button Фильтры.png|x25px]] [4] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора проекта, ветки и снимка]].
| |
| # Запрос – фильтр, указанный в поле в верхней части [[Help:UI manual#Таблица маркеров|таблицы маркеров]] [5].
| |
|
| |
| :[[File:36 Фильтры.png|thumb|none|upright=3|Существующие фильтры]]
| |
| | |
| Увидеть примененные фильтры (кроме '''Доступные для разметки''') и последовательность их применения можно в поле [[File:field Детектор.png|x25px]] в верхней части [[Help:UI manual#Таблица маркеров|таблицы маркеров]].
| |
| | |
| Все виды фильтров можно использовать одновременно, но при определенном порядке применения фильтры могут быть сброшены:
| |
| * запрос сбрасывается после применения любого другого фильтра;
| |
| * фильтры [[Help:UI manual#Функции навигационной панели|навигационной панели]] сбрасываются после применения [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] и других фильтров [[Help:UI manual#Функции навигационной панели|на навигационной панели]];
| |
| * [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательские фильтры]] и фильтры [[Help:UI manual#Функции навигационной панели|навигационной панели]] не сбрасываются при применении фильтра '''Размеченный''';
| |
| * при переключении на другой [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|проект, ветку или снимок]] примененные фильтры '''Размеченный''' и [[Help:UI manual#Настройка и использование пользовательских фильтров|'''Пользовательский''']] не сбрасываются и применяются к выбранному снимку.
| |
| | |
| По нажатию кнопки [[File:Button Фильтры 2.png|x25px]] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора контекста]] можно отменить примененные фильтры: пользовательский или все.
| |
| | |
| ==== Настройка и использование пользовательских фильтров ====
| |
| Настроить пользовательские фильтры можно [[Help:UI manual#Работа в режиме разметки|в режиме разметки]]. Для этого:
| |
| :1. Нажмите кнопку [[file:button Фильтры.png|x25px]] в правой части блока [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выбора контекста]].
| |
| :В правой части экрана отобразится панель пользовательских фильтров, которая содержит три вкладки:
| |
| :* '''Пользовательский''' – параметры фильтрации, которые разделены на три группы:
| |
| ::* параметры детекторов;
| |
| ::* параметры маркеров;
| |
| ::* файлы;
| |
| :* '''Сохраненные''' – список [[Help:UI manual#Работа с сохраненными фильтрами|сохраненных фильтров]];
| |
| :* '''Публичные''' – [[Help:UI manual#Работа с публичными фильтрами|список фильтров, доступных всем пользователям]].
| |
| | |
| :2. Настройте параметры фильтрации на вкладке '''Пользовательский''' – выберите значения в списках полей, нажмите кнопки со значениями, или введите значения.
| |
| :3. Нажмите на кнопку [[File:Icon cancel.png|x15px]] справа от значения в списке, чтобы отменить его выбор.
| |
| :4. Если параметры нужно исключить из поиска, нажмите на кнопку [[File:Icon plus 2.png|x25px]].
| |
| :Кнопка поменяется на [[File:Icon minus 3.png|x25px]].
| |
| :5. Если параметры нужно включить в поиск, нажмите на кнопку [[File:Icon minus 3.png|x25px]].
| |
| :Кнопка поменяется на [[File:Icon plus 2.png|x25px]].
| |
| :6. Если в полях '''Метки''', '''Функции''' и '''Файлы''' нужно использовать регулярные выражения:
| |
| ::а) Нажмите на кнопку [[File:Button TextTempl.png|x25px]].
| |
| ::Кнопка поменяется на [[File:Button Reg.png|x25px]].
| |
| ::б) Введите [[Help:UI manual#Использование регулярных выражений|регулярные выражения]]. Используйте новую строку для разделения значений.
| |
| :7. Если в полях '''Метки''', '''Функции''' и '''Файлы''' нужно использовать текстовые шаблоны:
| |
| ::а) Нажмите на кнопку [[File:Button Reg.png|x25px]].
| |
| ::Кнопка поменяется на [[File:Button TextTempl.png|x25px]].
| |
| ::б) Введите текстовые шаблоны. Используйте новую строку для разделения значений.
| |
| :8. Нажмите кнопку [[File:Button Очистить.png|x25px]], чтобы очистить все параметры фильтрации.
| |
| :9. <span id="filters_saved"></span>Нажмите кнопку [[File:Button Сохранить как.png|x25px]], в открывшемся диалоге введите название и нажмите кнопку '''Сохранить'''.
| |
| :Фильтр сохранится и отобразится на [[Help:UI manual#Работа с сохраненными фильтрами|вкладке '''Сохраненные''']].
| |
| :10. Нажмите кнопку [[File:Button Применить.png|x25px]], чтобы применить фильтр.
| |
| :После применения кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.
| |
| ::[[File:36 Пользовательские фильтры.png|thumb|none|upright=2|Пользовательские фильтры. Вкладка '''Пользовательский''']]
| |
| | |
| ==== Работа с сохраненными фильтрами ====
| |
| На вкладке '''Сохраненные''' отображаются фильтры, [[Help:UI manual#filters saved|сохраненные на вкладке '''Пользовательский''']], а также [[Help:UI manual#filters published|скопированные с вкладки '''Публичные''']].
| |
| :[[File:37 Фильтры сохраненные.png|thumb|none|upright=2|Пользовательские фильтры. Вкладка '''Сохраненные''']]
| |
| | |
| Воспользуйтесь функциями управления фильтрами на вкладке '''Сохраненные''':
| |
| :1. Для поиска фильтра введите его название в строке поиска.
| |
| :2. Для сортировки фильтров по названию нажмите кнопку [[File:Button Sort.png|x25px]].
| |
| :3. Для редактирования сохраненного фильтра нажмите кнопку [[File:Icon edit3.png|x25px]] и [[Help:UI manual#Настройка и использование пользовательских фильтров|внесите изменения]].
| |
| :4. Создайте дубликат фильтра – нажмите кнопку [[File:Icon duplicate.png|x25px]].
| |
| :5. <span id="filters_publishing"></span>Для публикации фильтра нажмите кнопку [[File:Button share.png|x25px]].
| |
| :Копия сохраненного фильтра отобразится [[Help:UI manual#Работа с публичными фильтрами|на вкладке '''Публичные''']] и станет доступна другим пользователям.
| |
| :{{Note|type=warn|text=''Функция доступна только пользователям с [[#Серверные доступы|серверным доступом]] '''Управление публичными фильтрами'''''.}}
| |
| :6. Для удаления одного фильтра нажмите кнопку [[File:Icon delete 2.png|x25px]].
| |
| :7. Для удаления нескольких фильтров:
| |
| ::а) Выберите фильтры для удаления – установите флажки в левой части названий фильтров или нажмите кнопку '''Выбрать всё'''.
| |
| ::б) Нажмите кнопку '''Удалить'''.
| |
| :8. Примените фильтр – нажмите на его название и нажмите кнопку [[File:Button Применить.png|x25px]].
| |
| | |
| После применения:
| |
| * примененный фильтр будет отмечен [[File:Icon check.png|x25px]];
| |
| * кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.
| |
| | |
| ==== Работа с публичными фильтрами ====
| |
| {{Note|type=warn|text=''Создание (публикация), изменение и удаление публичных фильтров доступны пользователям с [[#Серверные доступы|серверным доступом]] '''Управление публичными фильтрами'''''.}}
| |
| | |
| На вкладке '''Публичные''' отображаются фильтры, [[Help:UI manual#filters publishing|опубликованные на вкладке '''Сохраненные''']].
| |
| <gallery mode="packed" heights="300px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
| |
| 153 Пользовательские фильтры. Публичные без доступа.png|Пользовательские фильтры. Вкладка '''Публичные'''. </br>Вид для пользователя без серверного доступа </br>'''Управление публичными фильтрами'''
| |
| 154 Пользовательские фильтры. Публичные с доступом.png|Пользовательские фильтры. Вкладка '''Публичные'''. </br>Вид для пользователя с серверным доступом </br>'''Управление публичными фильтрами'''
| |
| </gallery>
| |
| <br clear=all />
| |
| Воспользуйтесь функциями управления фильтрами на вкладке '''Публичные''':
| |
| :1. Для поиска фильтра введите его название в строке поиска.
| |
| :2. Для сортировки фильтров по названию нажмите кнопку [[File:Button Sort.png|x25px]].
| |
| :3. Чтобы посмотреть параметры фильтра, нажмите кнопку [[File:Button show.png|x25px]].
| |
| :{{Note|type=warn|text=''Функция доступна только пользователям БЕЗ [[#Серверные доступы|серверного доступа]] '''Управление публичными фильтрами.'''''}}
| |
| :4. Для редактирования публичного фильтра нажмите кнопку [[File:Icon edit3.png|x25px]] и [[Help:UI manual#Настройка и использование пользовательских фильтров|внесите изменения]].
| |
| :5. <span id="filters_published">Скопируйте публичный фильтр – нажмите кнопку [[File:Icon duplicate.png|x25px]].</span>
| |
| :Фильтр сохранится и отобразится [[Help:UI manual#Работа с сохраненными фильтрами|на вкладке '''Сохраненные''']].
| |
| :6. Для удаления одного фильтра нажмите кнопку [[File:Icon delete 2.png|x25px]].
| |
| :7. Для удаления нескольких фильтров:
| |
| ::а) Выберите фильтры для удаления – установите флажки в левой части названий фильтров или нажмите кнопку '''Выбрать всё'''.
| |
| ::б) Нажмите кнопку '''Удалить'''.
| |
| :8. Примените фильтр – нажмите на его название и нажмите кнопку [[File:Button Применить.png|x25px]].
| |
| | |
| После применения:
| |
| * примененный фильтр будет отмечен [[File:Icon check.png|x25px]];
| |
| * кнопка фильтра станет зеленой, а ее название поменяется на название сохраненного фильтра.
| |
| | |
| === Сравнение снимков и маркеров ===
| |
| Чтобы сравнить снимки и маркеры в них:
| |
| :1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]] – проект, ветку, снимок.
| |
| :2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сравнить с…'''.
| |
| :3. В открывшемся окне выберите проект, ветку и снимок для сравнения; нажмите кнопку [[File:Button Применить.png|x25px]].
| |
| :[[File:38 Выбор снимка для сравнения.png|thumb|none|upright=1.5|Выбор проекта, ветки и снимка для сравнения]]
| |
| :Результат сравнения отобразится [[Help:UI manual#Функции навигационной панели|в навигационной панели]] и [[Help:UI manual#Функции центральной панели|центральной панели]], причем:
| |
| :* вкладка '''Информация о снимке''' поменяется на вкладку '''Информация о различиях''' с информацией о двух сравниваемых снимках;
| |
| :* применится первый режим сравнения, в котором найдены результаты.
| |
| :4. Выберите режим сравнения.
| |
| :[[File:39 Выбор режима сравнения.png|800px|thumb|none|Выбор режима сравнения]]
| |
| :[[Help:UI manual#Функции навигационной панели|В навигационной панели]] и [[Help:UI manual#Функции центральной панели|центральной панели]] отобразятся только результаты выбранного режима сравнения. В режимах '''Сопоставленные''' и '''Одинаковые''' [[Help:UI manual#Таблица маркеров|в таблице маркеров]] добавится столбец с номером версии: V1 – маркер в файле текущего снимка, V2 – маркер в файле целевого снимка.
| |
| :{{Note|type=info|text=''Если при просмотре кода файла целевого снимка перейти к просмотру файла [[Help:UI manual#Работа в режиме просмотра кода|в режиме '''Код''']] (команда '''Открыть в режиме код'''), то режим сравнения закроется, отобразится контекст целевого снимка.''}}
| |
| <gallery heights="210" perrow="2" mode="packed" style="float:left; clear:right; margin-right:1em; margin-left:2em" "="">
| |
| File:40 Пример сравнения новые.png|Пример результатов сравнения в режиме '''Только в V1'''
| |
| File:41 Пример сравнения Отсутствующие.png|Пример результатов сравнения в режиме '''Только в V2'''
| |
| File:42 Пример сравнения Сопоставленные.png|Пример результатов сравнения в режиме '''Сопоставленные'''
| |
| File:43 Пример сравнения Одинаковые.png|Пример результатов сравнения в режиме '''Одинаковые'''
| |
| </gallery>
| |
| <br clear=all />
| |
| :5. Посмотрите различия в параметрах анализа – нажмите кнопку '''Показать различия''' на вкладке '''Информация о различиях'''.
| |
| :[[File:44 Различия в результатах анализа.png|600px|thumb|none|Сравнение настроек анализа]]
| |
| :6. Посмотрите различия в статистике разметки – нажмите кнопку '''Различия разметок'''.
| |
| :[[File:45 Различия в статистике по детекторам.png|thumb|none|600px|Сравнение статистики разметок]]
| |
| :7. Нажмите кнопку [[File:Icon download CSV.png|x25px]] или [[File:Icon download PDF.png|x25px]], чтобы скачать статистику в формате CSV или PDF.
| |
| :8. Отмените сравнение – нажмите кнопку [[File:Icon cancel 2.png|x25px]] в блоке выбора проекта, ветки и снимка.
| |
| <br />
| |
| | |
| === Сопоставление маркеров ===
| |
| {{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Разметка маркеров''' и [[#Серверные доступы|серверным доступом]] '''Администрирование сервера'''''}}
| |
| | |
| Если при импорте снимка в ветку проекта не все маркеры были автоматически сопоставлены (сформированы инварианты), то такие маркеры можно сопоставить вручную. При сопоставлении маркеров с разметкой, инварианту присваивается разметка маркера из последнего импортированного снимка.
| |
| | |
| Результат сопоставления, выполненного вручную, можно отменить.
| |
| ==== Сопоставление маркеров вручную ====
| |
| Сопоставление маркеров вручную проводится в два этапа:
| |
| :а) Выбор пар маркеров и их сопоставление, без сохранения в БД.
| |
| :б) Просмотр выбранных пар и подтверждение операции.
| |
| | |
| Чтобы вручную сопоставить маркеры:
| |
| :1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
| |
| :2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сопоставить маркеры'''.
| |
| :Откроется окно '''Сопоставить маркеры'''.
| |
| | |
| :3. <span id="MarksStep1"></span>Этап 1. На вкладке '''Сопоставление маркеров''':
| |
| ::а) Выберите снимок, маркеры которого нужно сопоставить с исходным.
| |
| ::Отобразятся две таблицы маркеров: слева – для исходного снимка, а справа – для выбранного.
| |
| ::б) Выберите маркеры для сопоставления – по одному в каждой таблице и нажмите кнопку '''Сопоставить''' (расположена над таблицей). Если требуется, повторите операцию для других пар маркеров.
| |
| ::Для сопоставленных маркеров справа от названия будет отображаться номер сопоставленной пары.
| |
| ::в) Для отмены сопоставления пары маркеров выберите любой сопоставленный маркер и нажмите '''Отменить сопоставление''' (расположена над таблицей). Если требуется, повторите операцию для других пар маркеров.
| |
| ::г) Для просмотра фрагмента кода, в котором находится маркер – нажмите кнопку [[File:icon_preview_code.png|x25px]].
| |
| ::д) Для отказа от дальнейшего сопоставления и отмены всех изменений нажмите кнопку '''Отмена'''.
| |
| ::е) Для перехода к подтверждению выбора нажмите кнопку '''Далее'''.
| |
|
| |
| :[[File:122 Выбор снимка и сопоставление пар маркеров.png|800px|thumb|none|Окно «Сопоставить маркеры». Выбор снимка и сопоставление пар маркеров]]
| |
| | |
| :4. Этап 2. В открывшейся форме:
| |
| ::а) Проверьте список сопоставленных пар маркеров для применения операций сопоставления.
| |
| ::б) Для корректировки списка сопоставленных пар маркеров нажмите кнопку '''Назад''' и выполните операции [[Help:UI manual#MarksStep1|Этапа 1]].
| |
| ::в) Для отказа от дальнейшего сопоставления и отмены всех изменений нажмите кнопку '''Отмена'''.
| |
| ::г) Для запуска операции сопоставления нажмите кнопку '''Подтвердить'''.
| |
|
| |
| :[[File:123 Подтверждение сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Подтверждение сопоставления]]
| |
| | |
| :По окончании операции для данной ветки проекта будет изменена конфигурация инвариантов. Всем пользователям, у которых открыт данный контекст, отобразится сообщение:
| |
|
| |
| :[[File:124 Сообщение об окончании сопоставления отмены.png|800px|thumb|none|Сообщение об окончании операции сопоставления]]
| |
| :{{Note|type=info|text=''При сопоставлении метки маркеров удаляются.''}}
| |
| | |
| ==== Отмена операций сопоставления ====
| |
| Отмена операций ручного сопоставления маркеров проводится в два этапа:
| |
| :а) Выбор операций ручного сопоставления для отмены (отката).
| |
| :б) Просмотр списка всех операций, которые будут отменены, и подтверждение отмены операций сопоставления.
| |
| | |
| Чтобы отменить (откатить) операции сопоставления:
| |
| :1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
| |
| :2. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] нажмите кнопку [[File:Button Сравнить с.png|x25px]] и в раскрывшемся списке выберите пункт '''Сопоставить маркеры'''.
| |
| :Откроется окно '''Сопоставить маркеры'''.
| |
| :3. Этап 1. На вкладке '''Отмена операций сопоставления''':
| |
| ::а) Выберите операции сопоставления маркеров, которые нужно отменить.
| |
| ::В списке отображаются операции ручного сопоставления маркеров в исходной ветке проекта.
| |
| ::б) Для отказа от продолжения операции нажмите кнопку '''Отмена'''.
| |
| ::в) Для перехода к подтверждению выбора нажмите кнопку '''Далее'''.
| |
|
| |
| :[[File:125 Выбор маркеров для отмены сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Выбор операций сопоставления маркеров для отмены]]
| |
| | |
| :4. Этап 2. В открывшейся форме:
| |
| ::а) Проверьте список операций сопоставления, которые будут отменены. Список операций, помимо выбранных пользователем операций сопоставления, может дополнительно включать другие связанные операции, которые также будут отменены.
| |
| ::б) Для корректировки выбранных операций сопоставления маркеров нажмите кнопку '''Назад''' и измените выбор маркеров.
| |
| ::в) Для отказа от продолжения операции нажмите кнопку '''Отмена'''.
| |
| ::г) Для запуска операции отмены сопоставления маркеров нажмите кнопку '''Подтвердить'''.
| |
|
| |
| :[[File:126 Подтверждение отмены сопоставления.png|800px|thumb|none|Окно «Сопоставить маркеры». Подтверждение отмены операций сопоставления]]
| |
| | |
| :По окончании операции для данной ветки проекта будет изменена конфигурация инвариантов. Всем пользователям, у которых открыт данный контекст, отобразится сообщение:
| |
|
| |
| :[[File:124 Сообщение об окончании сопоставления отмены.png|800px|thumb|none|Сообщение об окончании операции отмены сопоставления]]
| |
| :{{Note|type=info|text=''При отмене операции сопоставления метки маркеров удаляются.''}}
| |
| | |
| === Сравнение маркеров ===
| |
| Чтобы сравнить два маркера:
| |
| :1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]].
| |
| :2. Раскройте [[Help:UI manual#Таблица маркеров|таблицу маркеров]].
| |
| :3. Нажмите правой кнопкой мыши на строке маркера и выберите пункт '''Сравнить с ...'''
| |
| :[[File:155 Переход к сравнению маркеров.png|thumb|none|upright=2|Переход к сравнению маркеров]]
| |
| :Откроется окно выбора маркера для сравнения.
| |
| :[[File:46 Выбор маркера для сравнения.png|thumb|none|upright=3|Окно выбора маркера для сравнения]]
| |
| :{{Note|type=info|text=''При сравнении снимков для режимов '''Сопоставленные''' и '''Одинаковые''' в таблице маркеров по клику правой кнопкой мыши на строке маркера доступен пункт '''Сравнение с другой версией'''. При выборе данной команды происходит сравнение маркера с его версией из сравниваемого снимка.''}}
| |
| :4. Выберите проект, ветку и снимок.
| |
| :Отобразится список маркеров в выбранном снимке, где можно ввести запрос для поиска маркеров.
| |
| :[[File:47 Результат сравнения маркеров.png|thumb|none|upright=3|Выбор маркера для сравнения]]
| |
| :5. Дважды кликните на строке маркера или нажмите кнопку '''Сравнить''', чтобы перейти в окно сравнения маркеров.
| |
| :[[File:48 Различия исходного кода.png|thumb|none|upright=3|Окно сравнения маркеров]]
| |
| | |
| === Разметка маркера ===
| |
| Разметить маркер можно [[Help:UI manual#Работа в режиме разметки|в режиме разметки]] с помощью кнопок в верхней части [[Help:UI manual#Функции правой панели|правой панели]] или в виждете [[Help:UI manual#Вкладка с исходным кодом|на вкладке с исходным кодом]], а также по нажатии кнопки [[File:Icon edit.png|x25px]] в этих же частях интерфейса.<br />Разметка маркера заключается в установке статуса, а также опционально серьезности (критичности) и требуемого действия. Установка серьезности и действия доступны только после установки статуса.
| |
| <gallery mode="packed" heights="180px" style="float:left; clear:right; margin-right:1em; margin-left:0">
| |
| 49 Разметка Статус.png|Выбор статуса разметки маркера
| |
| 50 Разметка Серьезность.png|Выбор серьезности разметки маркера
| |
| 51 Разметка Действие.png|Выбор действия разметки маркера
| |
| 127 Кнопки разметки в виджете маркера.png|Кнопки разметки в виджете маркера на вкладке с исходным кодом
| |
| </gallery>
| |
| <br clear=all />
| |
| Если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке''', то при установке статуса, серьезности или действия откроется окно разметки, в котором обязательно нужно ввести комментарий.
| |
| :Редактор комментариев поддерживает синтаксис Markdown.
| |
| :Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
| |
| [[File:99 Окно разметки.png|400px|thumb|none|Окно разметки. Поле '''Комментарий''' – обязательное]]
| |
| Результаты разметки со связанными комментариями отображаются [[Help:UI manual#Функции правой панели|в правой панели]] на вкладке '''Комментарии'''. При этом можно поменять текст комментария, но не результат разметки. Для её изменения нужно заново установить статус, серьёзность и действие.
| |
| [[File:100 Правая панель Комментарии с разметкой.png|300px|thumb|none|Правая панель. Комментарии, добавленные при разметке]]
| |
| | |
| === Групповая разметка маркеров ===
| |
| Для групповой разметки:
| |
| :1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходные проект, ветку и снимок]].
| |
| :2. Включите отображение [[Help:UI manual#Таблица маркеров|таблицы маркеров]].
| |
| :3. Выберите маркеры для разметки – установите флажки в строках таблицы.
| |
| :4. Нажмите кнопку [[File:icon edit.png|x25px]] (доступна, если выбраны маркеры в таблице).
| |
| :[[File:53 Выбор маркеров для группразметки.png|thumb|none|upright=2.5|Выбор маркеров для групповой разметки]]
| |
| :Отобразится окно для групповой разметки.
| |
| :[[File:54 Окно групповой разметки.png|thumb|none|upright=2.5|Окно групповой разметки]]
| |
| :5. Разметьте выбранные маркеры: выберите статус разметки, а затем (опционально) статус серьезности (критичности) и требуемое действие – нажмите кнопки со значениями.
| |
| :6. Добавьте общий комментарий для выбранных маркеров.<br />
| |
| :Редактор комментариев поддерживает синтаксис Markdown.
| |
| :Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к этому комментарию.
| |
| :После того, как пользователь присвоил статусы и (или) написал комментарий, станет доступной кнопка '''Применить'''.<br />
| |
| :{{Note|type=info|text=''Ввод комментария обязателен, если [[Help:UI manual#Работа с проектами|для проекта]] установлен флаг '''Обязательный комментарий при разметке'''''.}}
| |
| :7. Если требуется отменить изменения, нажмите [[File:icon cross 01.png|x15px]] в правом верхнем углу окна или кнопку '''Отмена'''.<br />Диалоговое окно закроется, изменения не будут применены, выделение с выбранных для разметки маркеров не снимается.
| |
| :9. Нажмите кнопку '''Применить''', чтобы запустить процесс разметки.<br />
| |
| Прогресс разметки отображается в соответствующем окне. Запущенный процесс можно полностью отменить нажатием кнопки '''Отмена'''.<br />
| |
| В результате применения разметки текст маркеров [[Help:UI manual#Таблица маркеров|в таблице маркеров]] окрасится в цвет, соответствующий выставленному статусу.
| |
| | |
| <gallery widths="400" mode="nolines" style="float:center; clear:center; margin-right:1em; margin-left:0">
| |
| 56 Окно прогресса разметки.png|Окно прогресса разметки
| |
| 57 Результат групповой разметки.png|Пример таблицы маркеров после применения групповой разметки
| |
| </gallery>
| |
| <br clear=all />
| |
| | |
| === Блокировка разметки маркеров===
| |
| Пользователь может заблокировать другим пользователям возможность [[Help:UI manual#Разметка маркера|размечать маркер]] или [[Help:UI manual#Групповая разметка маркеров|группу маркеров]]. Это позволяет избежать коллизий при разметке маркеров несколькими пользователями.
| |
| | |
| Для блокировки разметки используйте кнопку [[File:icon unlocked.png|x25px]] в следующих частях пользовательского интерфейса:
| |
| :1. [[Help:UI manual#Вкладка «Детекторы»|На вкладке '''Детекторы''']]. В этом случае блокировка распространяется на все маркеры выбранного детектора в открытом проекте и ветке, для всех снимков ветки.
| |
| :2. [[Help:UI manual#Вкладка «Файлы»|На вкладке '''Файлы''']]. В этом случае блокировка распространяется на все маркеры в выбранном файле в открытом проекте и ветке, для всех снимков ветки.
| |
| :3. В верхней части [[Help:UI manual#Функции правой панели|правой панели]]. В этом случае блокировка распространяется на все эквивалентные маркеры в открытом проекте и ветке, для всех снимков ветки.
| |
| | |
| <gallery mode="packed" heights="200px" perrow="2" style="float:left; clear:right; margin-right:1em; margin-left:1em">
| |
| 58 Блокировка на вкладке Детекторы.png|Блокировка маркера на вкладке '''Детекторы'''
| |
| File:59_Блокировка_на_вкладке_Файлы.png|Блокировка маркера на вкладке '''Файлы'''
| |
| 60_Блокировка_на_правой_панели.png|Блокировка маркера на правой панели
| |
| </gallery>
| |
| <br clear=all />
| |
| | |
| Если один пользователь заблокировал маркер, то другой пользователь не сможет заблокировать детектор, которому принадлежит этот маркер, и файл, в котором этот маркер найден.<br />
| |
| | |
| Чтобы посмотреть все блокировки, перейдите в раздел [[Help:UI manual#Настройка сервера Svacer|'''Настройки''']] на [[Help:UI manual#Управление блокировками разметки|вкладку '''Блокировки''']]:
| |
| | |
| [[File:61 Просмотр всех блокировок.png|thumb|none|upright=3.5|Таблица блокировок]]
| |
| | |
| В этом разделе можно удалить только свои блокировки. Пользователь с доступом '''Удаление блокировок''' может удалить любые блокировки.
| |
| | |
| === Добавление комментария к нескольким маркерам ===
| |
| Для добавления комментария к нескольким маркерам одновременно:
| |
| :1. В режиме разметки [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку, снимок.
| |
| :2. Включите отображение [[Help:UI manual#Таблица Маркеров|таблицы маркеров]].
| |
| :3. Выберите маркеры для разметки – установите флажки в строках таблицы.
| |
| :4. Нажмите кнопку [[File:Button Comment Add.png|x25px]] (доступна, если выбраны маркеры в таблице).
| |
|
| |
| :[[File:128 Добавление общего комментария 1.png|400px|thumb|none|Выбор маркеров для добавления комментария к нескольким маркерам одновременно]]
| |
| :5. Отобразится окно для добавления комментария к нескольким маркерам одновременно.
| |
|
| |
| :[[File:129 Добавление общего комментария 2.png|600px|thumb|none|Окно добавления комментария к нескольким маркерам одновременно]]
| |
| :6. Введите комментарий.
| |
| :Редактор комментариев поддерживает синтаксис Markdown.
| |
| :Для упоминания пользователя, вставьте '''@''' и введите или выберите его логин. После добавления комментария по нажатии кнопки '''Применить''' указанному пользователю придет [[Help:UI manual#Просмотр уведомлений в интерфейсе Системы|уведомление в интерфейсе системы]] об упоминании с возможностью перехода к маркеру с этим комментарием.
| |
| :8. Нажмите кнопку '''Сохранить'''.
| |
| | |
| === Экспорт ===
| |
| В режиме разметки можно выполнить экспорт:
| |
| * [[Help:UI manual#Экспорт исходного кода с разметкой|исходного кода с разметкой]];
| |
| * [[Help:UI manual#Экспорт снимка в формате snap|снимка в формате snap]];
| |
| * [[Help:UI manual#Экспорт разметки и снимка в SARIF|снимка в формате SARIF]];
| |
| * [[Help:UI manual#Экспорт разметки|разметки в файл]].
| |
| {{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Экспорт снимков'''''}}
| |
| | |
| ==== Экспорт исходного кода с разметкой ====
| |
| Чтобы экспортировать с сервера исходный код с разметкой (опционально):
| |
| :1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
| |
| :2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''Исходный код с разметкой'''.
| |
| :[[File:62 Переход к экспорту кода с разметкой.png|600px|thumb|none|Переход к экспорту кода с разметкой]]
| |
| :3. В открывшемся окне:
| |
| ::а) Если требуется экспортировать разметку, установите флажок параметра '''Шаблон разметки''' и выберите шаблон для экспорта в списке справа.
| |
| ::б) Опционально включите или выключите очистку старых комментариев.
| |
| ::в) Опционально включите или выключите экспорт файлов с исходным кодом только выбранных в таблице маркеров или для всех маркеров в таблице, если маркеры не выбраны.
| |
| ::г) Опционально заполните поля для удаления префиксов и исключения путей.
| |
| ::д) Опционально введите регулярные выражения для очистки дополнительных строк (доступен, если включена очистка старых комментариев).
| |
| ::[[File:63 Окно экспорта кода с разметкой.png|600px|thumb|none|Окно экспорта кода с разметкой]]
| |
| | |
| ::Пример удаления префиксов путей: <code>/.build/</code>
| |
| | |
| ::При экспорте можно исключить файлы, соответствующие [[Help:UI manual#Использование регулярных выражений|регулярным выражениям]] в поле '''Исключить пути'''.
| |
| :4. Нажмите кнопку '''Экспортировать'''.
| |
| В итоге создастся архив файлов с исходным кодом и, если был выбран шаблон разметки, то в исходный код будет добавлена актуальная разметка, в соответствии с выбранным шаблоном.
| |
| | |
| ==== Экспорт снимка в формате snap ====
| |
| Чтобы экспортировать с сервера исходный код снимка в формате .snap:
| |
| :1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
| |
| :2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''Снимок (*.snap)'''.
| |
| :[[File:192 Разметка. Переход к экспорту снимка в формате snap.png|600px|thumb|none|Переход к экспорту снимка в формате snap]]
| |
| :Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится соответствующее всплывающее сообщение.
| |
| :[[File:193 Сообщение. Экспорт снимка.png|thumb|600px|thumb|none|Пример всплывающих сообщений при старте и окончании экспорта снимка]]
| |
| | |
| ==== Экспорт разметки и снимка в SARIF ====
| |
| Чтобы экспортировать разметку и при необходимости исходный код снимка в файл формата SARIF:
| |
| :1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
| |
| :2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''SARIF'''.
| |
| :[[File:194 Разметка. Переход к экспорту снимка SARIF.png|thumb|600px|thumb|none|Переход к экспорту снимка SARIF]]
| |
| :3. В открывшемся окне:
| |
| ::а) Выключите (опционально) формирование название файла по умолчанию – снимите соответствующий флажок и введите название снимка.
| |
| ::б) Опционально включите или выключите экспорт исходных файлов.
| |
| ::в) Нажмите кнопку '''Экспортировать'''.
| |
| :[[File:195 Окно экспорта SARIF.png|thumb|600px|thumb|none|Окно экспорта снимка SARIF]]
| |
| :Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится всплывающее сообщение.
| |
| :[[File:220 Сообщение. Экспорт SARIF.png|thumb|400px|thumb|none|Пример всплывающих сообщений при старте и окончании экспорта снимка в SARIF]]
| |
| | |
| ==== Экспорт разметки ====
| |
| Чтобы из ветки проекта экспортировать в файл разметку и/или комментарии:
| |
| :1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
| |
| :2. На вкладке '''Информация о снимке''' нажмите кнопку '''Экспорт''' и выберите пункт '''Разметка'''.
| |
| :[[File:196 Разметка. Переход к экспорту разметки.png|thumb|thumb|thumb|600px|none|Переход к экспорту разметки]]
| |
| :3. В открывшемся окне:
| |
| ::а) Выберите вариант экспорта.
| |
| ::б) Если требуется экспортировать неразмеченные маркеры, установите флажок '''Включая разметку со статусом "Undecided"'''.
| |
| ::в) Нажмите кнопку '''Экспортировать'''.
| |
| :[[File:197 Окно экспорта разметки.png|thumb|thumb|thumb|600px|none|Окно экспорта разметки]]
| |
| | |
| === Импорт разметки ===
| |
| В режиме разметки можно импортировать разметку из двух источников:
| |
| * [[Help:UI manual#Импорт разметки из файла|из файла]];
| |
| * [[Help:UI manual#Импорт разметки из исходного кода|из исходного кода снимка]].
| |
| {{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт разметки'''''}}
| |
| | |
| ==== Импорт разметки из файла ====
| |
| Чтобы импортировать файл с разметкой:
| |
| :1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
| |
| :2. На вкладке '''Информация о снимке''' нажмите кнопку '''Импорт''' и выберите пункт '''Разметка из файла'''.
| |
| :[[File:198 Разметка. Переход к импорту разметки из файла.png|thumb|thumb|thumb|600px|none|Переход к импорту файла с разметкой]]
| |
| :3. В открывшемся окне:
| |
| ::а) Выберите файл архива в формате .gz.
| |
| ::б) Выберите варианты импорта и действия при наличии конфликта разметки.
| |
| ::в) Нажмите кнопку '''Импортировать'''.
| |
| :[[File:199 Окно импорта файла с разметкой.png|thumb|600px|thumb|none|Окно импорта файла с разметкой]]
| |
| :По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
| |
| :[[File:200 Сообщение. Импорт разметки из файла.png|thumb|thumb|thumb|600px|none|Пример всплывающего сообщения об окончании импорта разметки из файла]]
| |
| | |
| ==== Импорт разметки из исходного кода ====
| |
| Чтобы импортировать разметку из исходного кода снимка в ветку проекта:
| |
| :1. [[Help:UI manual#Работа в режиме разметки|В режиме разметки]] [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|выберите исходный контекст]] – проект, ветку и снимок.
| |
| :2. На вкладке '''Информация о снимке''' нажмите кнопку '''Импорт''' и выберите пункт '''Разметка из исходного кода'''.
| |
| :[[File:201 Разметка. Переход к импорту разметки из кода.png|thumb|thumb|thumb|thumb|600px|none|Переход к импорту исходного кода с разметкой]]
| |
| :3. В открывшемся окне выберите шаблон разметки и нажмите кнопку '''Импортировать'''.
| |
| :[[File:134_Импорт_разметки.png|thumb|thumb|thumb|600px|none|Окно импорта исходного кода с разметкой]]
| |
| :По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
| |
| :[[File:203 Сообщение. Импорт разметки из кода.png|thumb|thumb|thumb|thumb|600px|none|Пример всплывающего сообщения об окончании импорта разметки из исходного кода снимка]]
| |
| | |
| === Работа с таблицей статистики ===
| |
| Чтобы посмотреть краткую статистику о разметке маркеров:
| |
| :1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].
| |
| :2. Перейдите [[Help:UI manual#Работа в режиме разметки|в режим разметки]].
| |
| :3. На вкладке '''Информация о снимке''' в строке свойства '''Статистика по детекторам''' нажмите кнопку '''Показать'''.
| |
| | |
| :[[File:64 Переход к просмотру статистики.png|600px|thumb|none|Переход к просмотру статистики]]
| |
| | |
| :Отобразится таблица статистики:
| |
| :[[File:65 Таблица статистики.png|600px|thumb|none|Таблица статистики]]
| |
| :4. Нажмите кнопку [[File:Icon download CSV.png|x20px]] или [[File:Icon download PDF.png|x20px]], чтобы выгрузить статистику в соответствующем формате.
| |
| :5. Нажмите кнопку [[File:Icon filter.png|x20px]] в строке статистики, чтобы применить [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательский фильтр]] с параметрами, которые соответствуют выбранному значению.
| |
| | |
| == Работа в режиме просмотра кода ==
| |
| Режим позволяет посмотреть исходный код снимков, который был обработан анализатором Svace.
| |
| | |
| Для этого:
| |
| :1. Перейдите в режим просмотра кода по кнопке меню [[File:Button Код.png|x25px]] в верхней части экрана.
| |
| :2. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите исходный контекст]].<br>
| |
| :{{Note|type=info|text=''По умолчанию выбран контекст (проект, ветка), заданный ранее в режиме [[Help:UI manual#Работа в режиме разметки|'''Разметка''']] или [[Help:UI manual#Режим формирования отчетов|'''Отчеты''']]. Если Пользователь перешел в раздел '''Кoд''' из режима сравнения снимков раздела [[Help:UI manual#Работа в режиме разметки|'''Разметка''']], то для изменения контекста требуется отменить режим сравнения.''}}
| |
| :В левой части экрана отобразится иерархический список файлов снимка, а в правой – поле для отображения исходного кода файла.
| |
| :[[File:67 Режим просмотра кода.png|600px|thumb|none|Режим просмотра кода]]
| |
| :3. Для поиска файла:
| |
| ::а) Кликните на поле поиска или нажмите комбинацию клавиш '''Ctrl+Shift+O'''.
| |
| ::б) В открывшемся окне введите поисковый запрос и выберите файл.
| |
| :4. В левой части экрана раскройте группу файлов и нажмите на имя файла.
| |
| :В правой части отобразится исходный код файла.
| |
| :[[File:68 Режим просмотра кода открыт один файл.png|600px|thumb|none|Пример одного открытого файла]]
| |
| :5. Если требуется, откройте другие файлы.
| |
| :Они отобразятся на отдельных вкладках, если выключена [[Help:UI manual#Настройка профиля пользователя|настройка '''Переиспользование вкладки в редакторе кода''']].
| |
| :[[File:69 Режим просмотра кода открыто три файла.png|600px|thumb|none|Пример трёх открытых файлов]]
| |
| :6. Для перехода к предыдущей или следующей строке, в которую пользователь устанавливал курсор, используйте кнопки [[File:Button left.png|x25px]] и [[File:Button right.png|x25px]] или сочетания клавиш '''Ctrl+< и Ctrl+>'''.
| |
| :7. Вызовите функции, доступные по нажатии правой кнопки мыши на строке исходного кода
| |
| :* '''Перейти к объявлению''' – для перехода к строке, в которой объявлена переменная;
| |
| :* '''Перейти к определению''' – для перехода к строке, в которой определена переменная и функция;
| |
| :* '''Найти ссылки''' – для просмотра ссылок в панели с иерархическим списком файлов, именами файлов и номерами строк, в которых найдены ссылки;
| |
| ::{{Note|type=info|text=''Если для выделенного элемента кода нет объявления, определения или ссылок, то отобразится сообщение: [[File:150 Объявление не найдено.png|x25px]], [[File:151 Определение не найдено.png|x25px]] или [[File:152 Ссылки не найдены.png|x25px]].''}}
| |
| ::[[File:24 Исходный код Cписок файлов со ссылками.png|thumb|none|600px|Cписок файлов с номерами строк, в которых найдены ссылки]]
| |
| :* '''Копировать прямую ссылку''' – копирование ссылки на строку кода в буфер обмена.
| |
| ::При переходе по этой ссылке будет открываться файл в режиме просмотра кода с курсором на той строке кода, для которой была скопирована ссылка;
| |
| :* '''Уменьшить''' и '''Увеличить''' – увеличение и уменьшение размера шрифта кода (эти функции также можно вызвать с помощью сочетаний клавиш '''Ctrl+Alt+-''' или '''Ctrl+Alt+=''').
| |
| :* '''Copy''' – для копирования строки в буфер обмена;
| |
| :* '''Command Palette''' – для вызова командной строки.
| |
| :6. Установите курсор в строке кода, чтобы отобразилось его позиционирование в правом нижнем углу.
| |
| :[[File:130 Позиционирование к коде.png|600px|thumb|none|Отображение позиционирования курсора в коде]]
| |
| :7. Сравните файлы – для этого:
| |
| ::а) Нажмите правой кнопки мыши на имени файла и выберите пункт '''Сравнить с…'''
| |
| ::[[File:156 Переход к сравнению файлов.png|thumb|none|600px|Переход к сравнению файлов]]
| |
| ::б) В открывшемся окне выберите файл для сравнения. Для этого выберите проект, ветку и снимок, а затем раскройте группы файлов или воспользуйтесь поисковой строкой, нажмите на имя файла.
| |
| ::По умолчанию выбраны проект и ветка исходного контекста.
| |
| ::в) Нажмите кнопку '''Сравнить'''.
| |
| :Откроется окно сравнения файлов.
| |
|
| |
| :[[File:Code compare 2.png|600px|thumb|none|Окно выбора файла для сравнения]]
| |
|
| |
| :[[File:Code_compare_3.png|600px|thumb|none|Окно сравнения файлов]]
| |
| | |
| ==Управление проектами и группами проектов==
| |
| В разделе '''Проекты''' отображаются все проекты со всеми ветками и снимками.
| |
| Для удобства работы проекты могут быть [[Help:UI manual#Работа с группами проектов|сгруппированы]]. Один проект может быть включен в несколько групп проектов.
| |
| [[File:101 Раздел Проекты.png|thumb|none|upright=3|Раздел '''Проекты''']]
| |
| | |
| ===Работа с проектами===
| |
| Список проектов отображается в левой части экрана и организован в виде иерархии. При этом:
| |
| * для проектов, разметку маркеров которых нужно в обязательном порядке снабжать комментариями, отображается иконка [[File:Icon comment.png|x25px]];
| |
| * в нижней части списка отображается общее количество проектов и веток с учетом примененных фильтров, а также выбранных проектов и веток.
| |
| В списке доступны:
| |
| * поиск по имени проекта;
| |
| * фильтрация списка по группам проектов;
| |
| * сортировка по названию или дате создания (по умолчанию – по названию).
| |
| При работе с проектами пользователю доступны следующие функции:
| |
| :1. Загрузка актуальных данных с сервера – для этого нажмите кнопку [[File:Icon refresh.png|x25px]].
| |
| :2. Просмотр списка веток – для этого нажмите на название проекта.
| |
| :Ветки отобразятся в этом же списке проекта на втором уровне.
| |
| :3. Просмотр списка снимков – для этого нажмите на название ветки.
| |
| :Список снимков отобразится в виде таблицы в правой части экрана.
| |
| :4. [[Help:UI manual#Работа с группами проектов|Группировка проектов]].
| |
| :5. Создание проекта:
| |
| ::а) Нажмите кнопку '''Создать проект'''.
| |
| ::Откроется окно создания проекта.
| |
| ::[[File:102 Создание проекта.png|thumb|none|upright=1.5|Окно создания проекта]]
| |
| ::б) Введите название проекта.
| |
| ::в) Для выбора одной или нескольких существующих групп кликните на поле '''Группы''' и выберите одно или несколько значений в списке:
| |
| ::[[File:157 Окно создания проекта. Выбор существующей группы.png|thumb|none|upright=1.5|Окно создания проекта. Пример выбора существующей группы]]
| |
| ::г) Для создания одной новой группы введите ее название и нажмите кнопку '''Создать''' в появившейся форме:
| |
| ::[[File:158 Окно создания проекта.Создание одной группы.png|thumb|none|upright=1.5|Окно создания проекта. Пример создания одной группы]]
| |
| ::д) Для создания нескольких новых групп введите их названия через запятую и нажмите кнопку '''Создать''' в появившейся форме:
| |
| ::[[File:159 Окно создания проекта. Создание нескольких групп.png|thumb|none|upright=1.5|Окно создания проекта. Пример создания двух групп]]
| |
| ::е) Установите флажок, если требуется при разметке маркеров обязательно добавлять комментарий.
| |
| ::ж) Нажмите кнопку '''Создать'''.
| |
| :При создании проекта автоматически создается ветка '''master'''.
| |
| :При импорте снимка в интерфейсе командной строки проект, при его отсутствии, добавляется автоматически.
| |
| :6. Добавление ветки: [[File:103 Создание ветки.png|thumb|right|none|upright=1.5|Окно добавления ветки в проект]]
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
| |
| ::б) В меню выберите пункт '''Создать ветку'''.
| |
| ::в) В открывшемся окне введите название ветки и нажмите кнопку '''Создать'''.
| |
| :При импорте снимка в интерфейсе командной строки ветка, при ее отсутствии, добавляется автоматически.
| |
| </br>
| |
| :7. Клонирование проекта со всеми ветками и снимками: [[File:132 Окно клонирования проекта.png|thumb|right|none|upright=1.5|Окно клонирования проекта]]
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
| |
| ::б) В меню выберите пункт '''Клонировать'''.
| |
| ::в) В открывшемся окне введите название нового проекта, при необходимости скорректируйте группы, в которые будет входить клонированный проект (по умолчанию, группы исходного проекта) и нажмите кнопку '''Клонировать'''.
| |
| </br>
| |
| :9. Редактирование параметров проекта:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
| |
| ::б) В меню выберите пункт '''Редактировать'''.
| |
| ::в) В открывшемся окне измените название проекта, скорректируйте список групп, в которые включен проект, и установите или снимите флажок обязательности комментария при разметке и нажмите кнопку '''Сохранить'''.
| |
| :10. Удаление одного проекта:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке проекта.
| |
| ::б) В меню выберите пункт '''Удалить'''.
| |
| ::в) Подтвердите удаление.
| |
| :11. Удаление нескольких проектов с ветками:
| |
| ::а) Выберите проекты для удаления – установите флажки в левой части названий проектов и веток или нажмите кнопку '''Выбрать всё'''.
| |
| ::б) Нажмите кнопку '''Удалить''' в верхней части списка проектов и подтвердите удаление.
| |
| При удалении проекта удаляются все его ветки и снимки, разрывается связь проекта с группами.
| |
| | |
| ===Работа с группами проектов===
| |
| Работа с группами проектов доступна на отдельной панели '''Группы проектов''', которая отрывается по нажатии кнопки [[File:Icon gear.png|x25px]] в списке проектов. При этом в нижней части списка отображается общее количество групп.
| |
| | |
| В списке групп доступны:
| |
| * поиск по названию группы;
| |
| * фильтрация списка по проектам.
| |
| | |
| [[File:104 Панель групп.png|thumb|none|upright=3|Панель '''Группы проектов''']]
| |
| При работе с группами проектов пользователю доступны следующие функции:
| |
| :1. Просмотр списка связанных с группой проектов – для этого нажмите на название группы.
| |
| :Проекты отобразятся в этом же списке групп на втором уровне.
| |
| <br/>
| |
| :2. Добавление группы: [[File:105 Создание группы.png|thumb|right|none|upright=1.5|Окно '''Создать группу''']]
| |
| ::а) Нажмите кнопку '''Создать группу'''.
| |
| ::б) В открывшемся окне введите название группы и выберите проекты, которые в неё войдут, нажмите кнопку '''Создать'''.
| |
| :Созданная группа отобразится в списке на панели '''Группы проектов'''.
| |
| <br/>
| |
| :3. Редактирование параметров группы: [[File:106 Редактирование группы.png|thumb|right|none|upright=1.5|Окно Редактировать группу]]
| |
| ::а) Нажмите кнопку [[File:Icon edit2.png|x25px]] в строке группы.
| |
| ::б) В открывшемся окне измените название группы, скорректируйте состав включенных в группу проектов.
| |
| ::в) Нажмите на кнопку [[File:Icon cancel.png|x25px]] справа от названия проекта в списке, чтобы исключить его из группы.
| |
| ::г) Нажмите кнопку '''Сохранить'''.
| |
| <br/>
| |
| :4. Исключение одного проекта из группы – для этого нажмите кнопку [[File:Icon hide marks.png|x25px]] в правой части списка проектов группы.
| |
| :5. Удаление одной группы – для этого нажмите кнопку [[File:Icon delete.png|x25px]] в правой части списка групп и подтвердите удаление.
| |
| :6. Удаление нескольких групп:
| |
| ::а) Выберите группы для удаления – установите флажки в левой части названий групп или нажмите кнопку '''Выбрать всё'''.
| |
| ::б) Нажмите кнопку '''Удалить''' в верхней части списка групп проектов и подтвердите удаление.
| |
| :При удалении группы разрывается связь проекта с группой. Сами проекты не удаляются.
| |
| | |
| ===Работа с ветками===
| |
| При работе с ветками проекта пользователю доступны следующие функции:
| |
| :1. Просмотр списка снимков – для этого нажмите на название ветки в списке проектов.
| |
| :Список снимков отобразится в виде таблицы в правой части экрана.
| |
| :2. Редактирование ветки: [[File:107 Редактирование ветки.png|thumb|right|upright=1.5|Окно редактирования ветки]]
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
| |
| ::б) В меню выберите пункт '''Редактировать'''.
| |
| ::в) В открывшемся окне измените название ветки и нажмите кнопку '''Сохранить'''.
| |
| <br/>
| |
| :3. Клонирование ветки проекта: [[File:108 Клонирование ветки.png|thumb|right|upright=1.5|Окно клонирования ветки]]
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
| |
| ::б) В меню выберите пункт '''Клонировать'''.
| |
| ::в) В открывшемся окне введите название новой ветки и нажмите кнопку '''Клонировать'''.
| |
| <br/>
| |
| :4. Экспорт разметки в файл: [[File:197 Окно экспорта разметки.png|thumb|right|upright=1.5|Окно экспорта разметки]]
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
| |
| ::б) В меню выберите пункт '''Экспорт разметки'''.
| |
| ::Откроется окно экспорта разметки.
| |
| ::в) Выберите вариант экспорта.
| |
| ::г) Если требуется экспортировать неразмеченные маркеры, установите флажок '''Включая разметку со статусом "Undecided"'''.
| |
| ::д) Нажмите кнопку '''Экспортировать'''.
| |
| ::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Экспорт снимков'''''}}
| |
| <br/>
| |
| :5. Импорт разметки из файла: [[File:199 Окно импорта файла с разметкой.png|thumb|right|upright=1.5|Окно импорта разметки]]
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
| |
| ::б) В меню выберите пункт '''Импорт разметки'''.
| |
| ::Откроется окно импорта разметки.
| |
| ::в) Выберите файл архива в формате .gz.
| |
| ::г) Выберите варианты импорта и действия при наличии конфликта разметки.
| |
| ::д) Нажмите кнопку '''Импортировать'''.
| |
| ::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт снимков'''''}}
| |
| <br/>
| |
| :6. Удаление ветки:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
| |
| ::б) В меню выберите пункт '''Удалить'''.
| |
| ::в) Подтвердите удаление.
| |
| ::При удалении ветки удаляются все ее снимки.
| |
| <br/>
| |
| :7. Очистка разметки: [[File:160 Окно очистки разметки.png|thumb|right|upright=1.5|Окно очистки разметки]]
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки.
| |
| ::б) В меню выберите пункт '''Очистить разметку'''.
| |
| ::в) В открывшемся окне выберите вариант очистки.
| |
| ::г) Нажмите кнопку '''Очистить'''.
| |
| ::{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектными доступами]] '''Управление ветками и снимками''', '''Разметка маркеров''' и [[#Cерверные доступы|серверным доступом]] '''Администрирование сервера'''.''}}
| |
| <br/>
| |
| :8. Копирование разметки в другой контейнер (проект и ветку): [[File:Image.png|thumb|right|upright=1.5|Окно копирования разметки в другой контейнер]]
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке ветки и в меню выберите пункт '''Копировать разметку'''.
| |
| ::б) В открывшемся окне выберите проект и ветку, в которые нужно скопировать разметку, а также действия, которые нужно выполнить при наличии разметки.
| |
| ::в) Нажмите кнопку '''Копировать'''.
| |
| <br/>
| |
| Разметка в контейнере состоит из множества размеченных маркеров. В целевой ветке уже может находиться разметка. Все множество маркеров в исходной ветке можно разбить на два:
| |
| * «Уникальные» – маркеры, которые есть только в исходной ветке;
| |
| * «Общие» – маркеры, которые есть как в ветке-источнике, так и в ветке-приемнике.
| |
| При выполнении операции копирования разметка в уникальных маркерах всегда копируется в ветку-приемник. Для «Общих» маркеров возможны несколько вариантов продолжения копирования, но по умолчанию выбран пункт '''Не копировать''' – в этом случае разметка в «Общих» маркерах в ветке-приемнике не изменяется.
| |
| | |
| Если выбрано действие '''Перезаписать''', разметка на «Общих» маркерах в целевом контейнере будет заменена разметкой из ветки-источника.
| |
| | |
| При выборе действия '''Перезаписать только старую разметку''' разметка из ветки-источника копируется в том случае, если ее метка времени более поздняя, чем та, которая указана в ветке-приемнике на данном маркере.
| |
| | |
| '''Пример'''
| |
| :Есть несколько контейнеров:
| |
| :* A с разметкой {(M1, D1), (M2, D2), (M3, D3)}
| |
| :* B с разметкой {(M4, D4), (M2, D5), (M3, D6)},
| |
| ::где M — это маркер, а D — разметка (включая метку времени).
| |
| | |
| :Операцию сравнения на разметке обозначим как >. Если метка времени в D1 больше, чем в D2, то D1 > D2.
| |
| :Пусть D2 > D5, а D3 < D6. Тогда операция копирования всегда скопирует разметку D1 (но не сам маркер), так как маркер M1 новый для контейнера B.
| |
| | |
| :Маркеры M2, M3 — общие для двух контейнеров, поэтому то, какая разметка будет в контейнере-приемнике, будет зависеть от выбранного варианта разрешения конфликта:
| |
| :* если выбран пункт '''Не копировать''', то в контейнере B на маркерах M2, M3 будет разметка D5, D6 соответственно;
| |
| :* если выбран пункт '''Перезаписать''', то на M2, M3 будет разметка D2, D3;
| |
| :* если выбран пункт '''Перезаписать только старую разметку''', то на M2, M3 разметка будет: D2, D6, так как D2 > D5 и D6 > D3.
| |
| :При выполнении копирования наличие маркера в ветке-приемнике не проверяется.
| |
| :При успешном копировании выводится всплывающее сообщение с описанием выполненных операций:
| |
| :[[File:161 Сообщение об успешном копировании разметки.png|thumb|none|upright=2|Пример всплывающего сообщения об успешном копировании разметки]]
| |
| | |
| ===Работа со снимками===
| |
| Список снимков отображается в правой части экрана в виде таблицы после выбора ветки проекта. При этом в нижней части списка отображается общее количество снимков в выбранной ветке и количество выбранных снимков.
| |
| В списке доступны:
| |
| * поиск по названию снимка;
| |
| * сортировка по значениям столбцов (по умолчанию — по дате создания).
| |
| При работе со снимками пользователю доступны следующие функции:
| |
| :1. Импорт снимка из файла – для этого нажмите кнопку '''Импорт''' в верхней части табличного списка снимков и в открывшемся списке выберите один из вариантов импорта: '''Снимок (*.snap)''', '''Архив .svace-dir''' или '''SARIF'''.
| |
| :{{Note|type=warn|text=''Функциональность доступна пользователям с [[#Проектные доступы|проектным доступом]] '''Импорт снимков'''''}}
| |
| :После этого:
| |
| [[File:110 Импорт снимка.png|thumb|right|upright=1.5|Окно импорта снимка из файла в формате snap]]
| |
| ::а) Если выбран импорт из файла в формате snap, то в открывшемся окне выберите файл в формате .snap, введите название снимка (опционально) и нажмите кнопку '''Импортировать'''.
| |
| ::{{Note|type=info|text=''Если при импорте снимка из snap-файла название не введено, то будет использовано название исходного снимка (параметр «name» в JSON с информацией о снимке).''}}
| |
| [[File:133 Импорт снимка из архива svace-dir.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате svace-dir]]
| |
| [[File:133.1_Импорт_снимка_из_архива_svace-dir_-_Поля_опций.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате svace-dir. Поля опций для расширенных настроек]]
| |
| <br/>
| |
| ::б) Если выбран импорт архива .svace-dir, то в открывшемся окне:
| |
| ::* выберите архив .svace-dir;
| |
| ::* введите название снимка (опционально);
| |
| ::* выберите шаблон разметки (опционально);
| |
| ::* укажите правила префикса пути (опционально);
| |
| ::* укажите расширенные настройки (опционально): для каждой настройки нажмите кнопку '''Добавить''', в появившихся полях выберите опцию и введите её значение; для удаления настройки нажмите кнопку [[File:Icon delete.png|x25px]].
| |
| ::После выбора параметра в поле появляется иконка [[File:Icon question mark2.png|x15px]], по наведении курсора на которую можно посмотреть описание;
| |
| ::* нажмите кнопку '''Импортировать'''.
| |
| ::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
| |
| ::[[File:210 Сообщение. Импорт svace-dir.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании импорта снимка из архива в формате svace-dir]]
| |
| <br/>
| |
| [[File:217 Импорт снимка SARIF.png|thumb|right|upright=1.5|Окно импорта снимка из файла в формате SARIF]]
| |
| [[File:218 Импорт снимка SARIF - поля опций.png|thumb|right|upright=1.5|Окно импорта снимка из архива в формате SARIF. Поля опций для расширенных настроек]]
| |
| ::в) Если выбран импорт из файла в формате SARIF, то в открывшемся окне:
| |
| ::* выберите файл в формате .sarif или .json, либо архив в одном из форматов: .tar, tar.bz2, tar.gz, zip;
| |
| ::* введите название снимка (опционально);
| |
| ::* укажите правила префикса пути (опционально);
| |
| ::* укажите расширенные настройки (опционально): для каждой настройки нажмите кнопку '''Добавить''', в появившихся полях выберите опцию и введите её значение; для удаления настройки нажмите кнопку [[File:Icon delete.png|x25px]].
| |
| ::После выбора параметра в поле появляется иконка [[File:Icon question mark2.png|x15px]], по наведении курсора на которую можно посмотреть описание;
| |
| ::* нажмите кнопку '''Импортировать'''.
| |
| ::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
| |
| ::[[File:211 Сообщение. Импорт SARIF.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании импорта снимка из архива в формате SARIF]]
| |
| :{{Note|type=info|text='''''Примечание:'''''
| |
| :* ''для импорта поддерживаются архивы папки .svace-dir, заархивированные с помощью tar, gz, bz2 или zip (*.tar, *.tar.gz, *.tar.bz2, *.zip);''
| |
| :* ''если при импорте архива .svace-dir название снимка не введено, то оно будет соответствовать времени импорта результатов анализа из Svace;''
| |
| :* ''в поле '''Расширенные настройки''' поддерживается ввод дополнительных опций команды <code>svacer import</code> – как в интерфейсе командной строки (например, <code>--attach value</code>). В аргументах дополнительных опций требуется указывать пути относительно архивированной папки. Описание опций можно найти, запустив команду <code>svacer import --help</code>''.
| |
| :* ''для импорта снимка из snap-файла, .svace-dir или SARIF может потребоваться много времени: как на загрузку, так и на обработку данных после загрузки. При работе сервера Svacer за reverse proxy их дефолтных значений таймаутов или ограничений на размер загружаемых данных может быть недостаточно, поэтому рекомендуется увеличить эти значения в конфигурационных файлах reverse proxy, см. [[Help:Installation#Nginx|пример для Nginx]]''}}
| |
| | |
| :2. Переход к разметке маркеров снимка:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
| |
| ::б) В меню выберите пункт '''Разметить'''.
| |
| [[File:111 Редактирование снимка.png|thumb|right|upright=1.5|Окно редактирования снимка]]
| |
| :3. Редактирование названия снимка:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
| |
| ::б) В меню выберите пункт '''Редактировать'''.
| |
| ::в) Поменяйте название и нажмите кнопку '''Сохранить'''.
| |
| [[File:212 Окно Копирование снимков.png|thumb|right|upright=1.5|Окно копирования снимка. Пример для одного снимка]]
| |
| :4. Копирование одного снимка в другой проект и ветку:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
| |
| ::б) В меню выберите пункт '''Копировать'''.
| |
| ::в) В открывшемся окне выберите проект и ветку, в которые нужно добавить копию снимка, нажмите кнопку '''Копировать'''.
| |
| ::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
| |
| ::[[File:213 Сообщение. Копирование снимков.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании копирования одного снимка]]
| |
| [[File:214 Окно Копирование нескольких снимков.png|thumb|right|upright=1.5|Окно копирования снимка. Пример для двух снимков]]
| |
| :5. Копирование нескольких снимков в другой проект и ветку:
| |
| ::а) Чтобы выбрать для копирования все снимки, установите флажок в заголовке табличного списка снимков.
| |
| ::б) Чтобы выбрать несколько снимков, установите флажки в крайнем правом столбце табличного списка.
| |
| ::в) Нажмите кнопку '''Копировать''' в верхней части табличного списка снимков.
| |
| ::г) В открывшемся окне выберите проект и ветку, в которые нужно добавить копии выбранных снимков, нажмите кнопку '''Копировать'''.
| |
| ::При старте операции и по ее окончании пользователю отобразятся соответствующие всплывающие сообщения.
| |
| ::[[File:215 Сообщение. Копирование двух снимков.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании копирования двух снимков]]
| |
| | |
| :6. Экспорт снимка в файл формата .snap:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
| |
| ::б) В меню выберите пункт '''Экспорт (*.snap)'''.
| |
| ::Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится соответствующее всплывающее сообщение.
| |
| ::[[File:193 Сообщение. Экспорт снимка.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании экспорта снимка]]
| |
| | |
| :[[File:195 Окно экспорта SARIF.png|thumb|right|upright=1.5|Окно экспорта снимка SARIF]]
| |
| :7. Экспорт снимка в файл формата SARIF:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
| |
| ::б) В меню выберите пункт '''Экспорт SARIF'''.
| |
| ::в) В открывшемся окне:
| |
| :::* Выключите (опционально) формирование название файла по умолчанию – снимите соответствующий флажок и введите название снимка.
| |
| :::* Опционально включите или выключите экспорт исходных файлов.
| |
| :::* Нажмите кнопку '''Экспортировать'''.
| |
| ::Запустится формирование файла. При старте и по окончании экспорта пользователю отобразится всплывающее сообщение.
| |
| ::[[File:220 Сообщение. Экспорт SARIF.png|thumb|none|upright=1.5|Пример всплывающих сообщений при старте и окончании экспорта снимка в SARIF]]
| |
| | |
| :[[File:134 Импорт разметки.png|thumb|right|upright=1.5|Окно импорта разметки]]
| |
| :8. Импорт разметки из комментариев исходного кода снимка в активную ветку проекта:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в крайнем правом столбце строки снимка.
| |
| ::б) В меню выберите пункт '''Импорт разметки из исходного кода'''.
| |
| ::в) В открывшемся окне выберите шаблон разметки и нажмите кнопку '''Импортировать'''.
| |
| ::По окончании пользователю отобразится всплывающее сообщение с информацией о выполненной операции.
| |
| ::[[File:216 Сообщение. Импорт разметки из кода.png|thumb|none|upright=1.5|Пример всплывающего сообщения об окончании импорта разметки из файла]]
| |
| | |
| :9. Просмотр информации о снимке в JSON-формате:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке снимка крайнем правом столбце.
| |
| ::б) В меню выберите пункт '''Просмотреть JSON'''.
| |
| :[[File:112 Просмотр JSON снимка.png|thumb|none|upright=3|Окно просмотра информации о снимке в JSON-формате]]
| |
| :10. Удаление одного снимка:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке снимка крайнем правом столбце.
| |
| ::б) В меню выберите пункт '''Удалить'''.
| |
| ::в) Подтвердите удаление.
| |
| :11. Удаление нескольких снимков:
| |
| ::а) Чтобы выбрать для удаления все снимки, установите флажок в заголовке табличного списка снимков.
| |
| ::б) Чтобы выбрать несколько снимков, установите флажки в крайнем правом столбце табличного списка.
| |
| ::в) Нажмите кнопку '''Удалить''' в верхней части табличного списка снимков и подтвердите удаление.
| |
| | |
| == Режим формирования отчетов ==
| |
| Режим позволяет сформировать отчеты на основе хранимой информации, посмотреть их в пользовательском интерфейсе и выгрузить в формате .json. Для этого:
| |
| :1. [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|Выберите контекст]].
| |
| :{{Note|type=info|text=''По умолчанию выбран контекст (группа проектов, проект, ветка), заданный ранее в режиме [[Help:UI manual#Работа в режиме разметки|'''Разметка''']] или [[Help:UI manual#Работа в режиме просмотра кода|'''Код''']]. Если Пользователь перешел в раздел '''Отчеты''' из режима сравнения снимков раздела [[Help:UI manual#Работа в режиме разметки|'''Разметка''']], то для изменения контекста требуется отменить режим сравнения.''}}
| |
| :2. Перейдите в раздел '''Отчеты''' в верхней части экрана.
| |
| :Отобразится форма формирования отчетов:
| |
| :[[File:70 Форма формирования отчетов.png|thumb|none|upright=3|Форма формирования отчетов]]
| |
| :3. На панели слева выберите требуемый отчет: '''Общий отчет''' или '''Тренды'''.
| |
| :4. Выберите текущий и целевой снимки:
| |
| :[[File:71 Выбор снимков для формирования отчета.png|thumb|none|upright=3|Выбор снимков для формирования отчета]]
| |
| :5. Нажмите кнопку [[File:Button Play.png|x25px]] для запуска формирования отчета и его отображения в пользовательском интерфейсе.
| |
| :6. Нажмите кнопку [[File:Icon download.png|x25px]] для выгрузки отчета в формате .json.
| |
| <gallery mode="slideshow" style="float:left; clear:right; margin-right:1em; margin-left:2em" "="">
| |
| File:72 Пример общего отчета.png|Пример общего отчета. Часть 1
| |
| File:72.2 Пример общего отчета часть2.png|Пример общего отчета. Часть 2
| |
| File:72.3 Пример общего отчета часть3.png|Пример общего отчета. Часть 3
| |
| File:72.4 Пример общего отчета часть4.png|Пример общего отчета. Часть 4
| |
| File:72.5 Пример общего отчета часть5.png|Пример общего отчета. Часть 5
| |
| </gallery><br clear="all" />
| |
| :[[File:73 Пример отчета Тренды.png|600px|thumb|none|Пример отчета '''Тренды''']]
| |
| | |
| == Просмотр детекторов ==
| |
| Чтобы посмотреть список всех детекторов, перейдите в раздел '''Детекторы''':
| |
|
| |
| [[File:135 Раздел Детекторы.png|thumb|none|upright=3|Раздел «Детекторы»]]
| |
| | |
| В разделе отображается список детекторов той версии Svace, которая указана вверху раздела.
| |
| | |
| {{Note|type=info|text=''При обновлении списка детекторов и их параметров в Svace изменения попадают в Svacer при выпуске новой версии системы!''}}
| |
| | |
| В разделе '''Детекторы''' пользователю доступны следующие функции:
| |
| :1. Поиск детектора по его названию, серьезности, надежности и коду дефекта безопасности CWE.
| |
| :2. Сортировка по значениям столбцов (по умолчанию – по названию детектора).
| |
| :3. Переход к просмотру описания дефекта безопасности на сайте [https://cwe.mitre.org cwe.mitre.org] (открывается в отдельном окне) – для этого нажмите на ссылку в столбце '''CWE'''.
| |
| :4. Просмотр дополнительной информации о детекторе при её наличии – для этого нажмите на иконку [[File:icon_question_mark2.png|x25px]] справа от названия детектора.
| |
|
| |
| :[[File:121_Окно с дополнительной информацией о детекторе.png|thumb|none|upright=2|Раздел «Детекторы». Пример окна с дополнительной информацией о детекторе]]
| |
| | |
| :5. Фильтрация списка – для этого:
| |
| ::а) Нажмите кнопку [[File:Button Фильтр.png|x25px]].
| |
| ::б) В открывшемся окне '''Фильтр''' настройте параметры фильтрации – выберите значения в списках полей или нажмите кнопки со значениями.
| |
| ::в) Нажмите кнопку [[File:button_Очистить.png|x25px]], чтобы очистить все параметры фильтрации.
| |
| ::г) Нажмите кнопку [[File:button_Применить.png|x25px]], чтобы применить фильтр.
| |
|
| |
| :[[File:137 Детекторы.Фильтр.png|thumb|none|upright=2|Раздел «детекторы». Окно «Фильтр»]]
| |
| | |
| :6. Отмена примененных фильтров – для этого нажмите кнопку [[File:Button Фильтр отмена.png|x25px]].
| |
| :7. Выбор отображаемых столбцов – для этого нажмите на кнопку '''Столбцы''' и в открывшемся списке установите или снимите флажки рядом с названиями столбцов.
| |
| :Для настройки скрытия или показа доступны все столбцы, кроме '''Детектор'''. Столбцы '''Статус''' и '''Инструменты''' по умолчанию скрыты.
| |
| :Пользовательская настройка отображения столбцов сохраняется и не сбрасывается при повторном входе пользователя в систему.
| |
| | |
| :[[File:138 Детекторы выбор столбцов.png|thumb|none|upright=1.5|Раздел «Детекторы». Выбор отображаемых столбцов]]
| |
| | |
| :8. Экспорт списка детекторов в файл формата PDF – нажмите кнопку '''Экспорт в PDF'''.
| |
| :Файл содержит информацию обо всех детекторах, найденных с помощью строки поиска и фильтров. Настройка отображения столбцов не влияет на выгрузку – файл содержит информацию всех столбцов.
| |
| | |
| == Просмотр статистики ==
| |
| В разделе '''Статистика''' пользователь может посмотреть статистические данные о разметке по всем проектам, веткам и снимкам, доступным пользователю. Все статистические данные разделены на три группы и отображаются в отдельных дашбордах:
| |
| * [[Help:UI manual#Работа с дашбордом «Общая статистика»|'''Общая статистика''']] – показатели по последним импортированным снимкам в ветках проектов;
| |
| * [[Help:UI manual#Работа с дашбордом «Распределение маркеров»|'''Распределение маркеров''']] – диаграммы с информацией о количестве маркеров и их распределении по серьезности, статусу разметки и языкам;
| |
| * [[Help:UI manual#Работа с дашбордом «Активность по разметке»|'''Активность по разметке''']] – информация об активности пользователей при разметке маркеров.
| |
| | |
| [[File:162 Раздел Статистика. Начальное состояние.png|thumb|none|upright=3|Раздел '''Статистика'''. Начальное состояние]]
| |
| Чтобы посмотреть информацию:
| |
| :1. Выберите дашборд – нажмите кнопку с его названием в верхней части экрана.
| |
| :2. Выберите [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|контекст]] (опционально). В дашборде '''Общая статистика''' выбор снимка недоступен.
| |
| :2. Нажмите кнопку [[File:Button Play.png|x25px]].
| |
| :Если контекст не был выбран, отобразится статистика по всем проектам, веткам и снимкам, доступным пользователю. При этом информация об их количестве отображается в верхней части каждого дашборда.
| |
| :[[File:163 Раздел Статистика. Контекст не выбран.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Пример дашборда '''Общая статистика'''. Контекст не выбран]]
| |
| :Если контекст был выбран, то отобразится статистика только для выбранных проектов, веток и снимков (кроме '''Общая статистика'''). При этом информация об их количестве отображается в верхней части каждого дашборда.
| |
| :[[File:164 Раздел Статистика. Контекст выбран.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Пример дашборда '''Общая статистика'''. Контекст выбран]]
| |
| | |
| === Работа с дашбордом «Общая статистика» ===
| |
| На дашборде '''Общая статистика''' отображается информация о разметке маркеров в последних импортированных снимках в разрезе проектов и веток. Информация представлена в виде блоков со следующими данными:
| |
| * общая информация:
| |
| ** названия проекта и ветки;
| |
| ** количество снимков в ветке и дата последнего импорта;
| |
| ** дата последней разметки маркеров;
| |
| * показатели последнего импортированного снимка:
| |
| ** количество строк кода;
| |
| ** количество маркеров;
| |
| ** плотность маркеров – процентное отношение количества маркеров на тысячу строк кода;
| |
| ** процент и количество размеченных маркеров;
| |
| ** процент и количество подтвержденных маркеров – со статусом Confirmed;
| |
| ** процент и количество критичных маркеров – с серьезностью детектора Critical.
| |
| :[[File:204 Статистика. Общая статистика.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Дашборд '''Общая статистика''']]
| |
| Пользователю доступны следующие функции:
| |
| :1. Поиск информации по названиям проектов и веток.
| |
| :2. Сортировка данных – для этого в поле справа выберите показатель, по которому требуется сортировать информацию:
| |
| :* по датам последних разметки и импорта;
| |
| :* по показателям последнего импортированного снимка.
| |
| :Для изменения порядка сортировки используйте кнопки [[File:Button Sort.png|x25px]] и [[File:Button Sort UP.png|x25px]].
| |
| :3. Переход к последнему импортированному снимку в режиме разметки – нажмите на названия проекта и ветки в блоке.
| |
| | |
| === Работа с дашбордом «Распределение маркеров» ===
| |
| На дашборде '''Распределение маркеров''' отображаются три диаграммы:
| |
| * Количество маркеров по серьезности;
| |
| * Количество маркеров по статусу разметки;
| |
| * Распределение маркеров по языкам.
| |
| [[File:165 Раздел Статистика. Информация о выбранном контексте.png|thumb|none|upright=2.5|Раздел '''Статистика'''. Дашборд '''Распределение маркеров''']]
| |
| Пользователю доступны следующие функции:
| |
| :1. Просмотр значения диаграммы – для этого наведите курсор на любой графический элемент любой диаграммы.
| |
| :2. Выгрузка данных диаграммы в файл формата .csv – для этого нажмите кнопку [[File:Button Download.png|x25px]] в любой диаграмме.
| |
| | |
| === Работа с дашбордом «Активность по разметке» ===
| |
| На дашборде Активность по разметке отображается информация о действиях пользователей [[Help:UI manual#Работа в режиме разметки|по разметке маркеров]], которая может быть представлена в двух видах:
| |
| * диаграмма '''Активность по разметке''' – отражает активность пользователей по разметке маркеров за выбранный месяц (по умолчанию – текущий месяц). Цвет ячеек на диаграмме отражает количество действий пользователя, выполненных в указанную дату: чем темнее цвет, тем больше действий выполнил пользователь. Эта диаграмма отображается по умолчанию; если вид был переключен, то для возврата к этой диаграмме нажмите кнопку [[File:Button ChangeDiagram1.png|x25px]];
| |
| * диаграмма '''Лидеры по разметке''' – отражает количество действий пользователей при разметке за выбранный период (по умолчанию – период соответствует месяцу, указанному на диаграмме '''Активность по разметке''') с сортировкой по лидерам. Цвет строк на диаграмме отражает количество действий пользователя: чем темнее цвет, тем больше действий выполнил пользователь. Диаграмма отображается по нажатии кнопки [[File:Button ChangeDiagram2.png|x25px]];
| |
| [[File:166 Раздел Статистика. Активность по разметке.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Вид 1: диаграмма '''Активность по разметке''']]
| |
| [[File:167 Раздел Статистика. Лидеры по разметке.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Вид 2: диаграмма '''Лидеры по разметке''']]
| |
| Пользователю доступны следующие функции:
| |
| :1. Просмотр значения диаграммы – для этого наведите курсор на любой графический элемент любой диаграммы.
| |
| :2. Выгрузка данных диаграммы в файл формата .csv – для этого нажмите кнопку [[File:Button Download.png|x25px]] в любой диаграмме
| |
| :3. <span id="diagrams_details"></span>В диаграмме '''Активность по разметке''':
| |
| ::а) Поиск конкретного пользователя – для этого введите фрагмент его логина в поле поиска.
| |
| ::б) Просмотр статистики за любой другой месяц – для этого выберите год и месяц в раскрывающихся списках вверху диаграммы.
| |
| ::в) Просмотр активности конкретного пользователя за выбранный месяц – для этого нажмите на его логин.
| |
| ::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке выбранного пользователя. Измененная (неактуальная) разметка отмечена иконкой [[File:Icon archive.png|x25px]].
| |
| ::[[File:168 Раздел Статистика. Активность по разметке. Выбранный пользователь.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке выбранного пользователя]]
| |
| ::г) Просмотр активности пользователей в конкретный день месяца – для этого нажмите на число.
| |
| ::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке пользователей за выбранную дату.
| |
| ::[[File:169 Раздел Статистика. Активность по разметке. Пользователи за дату.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке пользователей за выбранную дату]]
| |
| ::д) Просмотр активности конкретного пользователя в конкретный день месяца – для этого нажмите ячейку таблицы на пересечении строки с логином пользователя и столбца с числом.
| |
| ::Ниже диаграммы '''Активность по разметке''' отобразится список действий по разметке выбранного пользователя за выбранную дату.
| |
| ::[[File:170 Раздел Статистика. Активность по разметке. Одни пользователь за дату.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Активность по разметке''' и список действий по разметке выбранного пользователя за выбранную дату]]
| |
| ::е) Включение и выключение отображения информации о неактуальной (измененной) разметке в списке действий пользователя – для этого воспользуйтесь переключателем '''Исключить активность по неактуальной разметке'''.
| |
| ::ж) Просмотр маркера в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] – для этого в списке действий нажмите на ссылку с именем файла и номером строки.
| |
| ::з) Просмотр информации о маркере [[File:205 Статистика. Активность по разметке. Панель с информацией о маркере.png|thumb|right|none|upright=1|Панель с информацией о маркере]] – для этого в списке действий нажмите кнопку [[File:Button show.png|x25px]] слева от названия маркера.
| |
| ::В правой части экрана отобразится панель с информацией о маркере.
| |
| :4. В диаграмме '''Лидеры по разметке''':
| |
| ::а) Поиск конкретного пользователя – для этого введите фрагмент его логина в поле поиска.
| |
| ::б) Просмотр статистики за любой другой период времени, кроме текущего месяца – для этого кликните на поле даты вверху диаграммы и вручную введите даты, либо в раскрывшемся календаре выберите диапазон дат: предложенный ('''Сегодня''', '''Вчера''', '''Неделю назад''' и т. п.) или свой.
| |
| ::[[File:171 Раздел Статистика. Лидеры по разметке. Выбор дат.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Лидеры по разметке'''. Выбор диапазона дат]]
| |
| ::в) Просмотр активности конкретного пользователя за указанный период – для этого нажмите на его логин.
| |
| ::Ниже диаграммы '''Лидеры по разметке''' отобразится список действий по разметке выбранного пользователя. Измененная (неактуальная) разметка отмечена иконкой [[File:Icon archive.png|x25px]].
| |
| ::[[File:172 Раздел Статистика. Лидеры по разметке. Выбранный пользователь.png|thumb|none|upright=3|Раздел '''Статистика'''. Дашборд '''Активность по разметке'''. Диаграмма '''Лидеры по разметке''' и список действий по разметке выбранного пользователя]]
| |
| ::г) Включение и выключение отображения в списке действий пользователя по неактуальной (измененной) разметке – для этого воспользуйтесь переключателем '''Исключить активность по неактуальной разметке'''.
| |
| ::д) Просмотр маркера в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] – для этого в списке действий нажмите на ссылку с именем файла и номером строки.
| |
| ::e) Просмотр информации о маркере – для этого в списке действий нажмите кнопку [[File:Button show.png|x25px]] слева от названия маркера.
| |
| ::В правой части экрана отобразится панель с информацией о маркере.
| |
| | |
| == Глобальный поиск ==
| |
| Глобальный поиск позволяет одновременно по всем доступным пользователю проектам и веткам выполнить поиск в следующих категориях:
| |
| * Маркеры;
| |
| * Комментарии к маркерам;
| |
| * Снимки.
| |
| | |
| Чтобы воспользоваться глобальным поиском, перейдите в раздел '''Поиск'''.
| |
| [[File:173 Раздел Поиск. Начальное состояние.png|thumb|none|upright=3|Раздел '''Поиск'''. Начальное состояние]]
| |
| | |
| Для каждой категории реализованы два независимых способа поиска в виде вкладок:
| |
| * '''Базовый поиск''' – единый поисковый запрос по всем атрибутам категории одновременно, с указанием контекста;
| |
| * '''Поиск по полям''' – позволяет задать значения поиска по каждому атрибуту категории в отдельности и указать контекст.
| |
| | |
| === Поиск маркеров ===
| |
| Чтобы воспользоваться поиском маркеров:
| |
| :1. Выберите категорию '''Маркеры''' раздела '''Поиск''' (выбран по умолчанию).
| |
| :2. Для базового поиска:
| |
| ::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
| |
| ::[[File:174 Раздел Поиск. Категория Маркеры. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Маркеры'''. Базовый поиск]]
| |
| ::б) Введите фрагмент названия маркера, детектора, функции или файла.
| |
| ::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти маркеры.
| |
| ::По умолчанию выбраны все группы, проекты, ветки и снимки.
| |
| ::г) Нажмите кнопку '''Поиск'''.
| |
| :Отобразятся результаты поиска.
| |
| :[[File:175 Раздел Поиск. Пример результатов поиска в категории Маркеры.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Маркеры''']]
| |
| :3. Для поиска по полям:
| |
| ::а) Перейдите на вкладку '''Поиск по полям'''.
| |
| ::[[File:176 Раздел Поиск. Категория Маркеры. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Маркеры'''. Поиск по полям]]
| |
| ::б) Заполните поля поиска.
| |
| ::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти маркеры.
| |
| ::По умолчанию выбраны все группы, проекты, ветки и снимки.
| |
| ::г) Нажмите кнопку '''Поиск'''.
| |
| :Отобразятся результаты поиска.
| |
| :[[File:177 Раздел Поиск. Пример результатов поиска по полям в категории Маркеры.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Маркеры''']]
| |
| :4. Для очистки значений в полях поиска нажмите кнопку '''Очистить'''.
| |
| :5. Чтобы посмотреть подробную информацию о найденном маркере, в результатах поиска кликните на ссылку в имени файла с номером строки исходного кода.
| |
| :Найденный маркер откроется в [[Help:UI manual#Работа в режиме разметки|режиме разметки]].
| |
| | |
| === Поиск комментариев к маркерам ===
| |
| Чтобы воспользоваться поиском по комментариям к маркерам:
| |
| :1. Выберите категорию '''Комментарии к маркерам''' раздела '''Поиск'''.
| |
| :2. Для базового поиска:
| |
| ::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
| |
| ::[[File:178 Раздел Поиск. Категория Комментарии к маркерам. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Комментарии к маркерам'''. Базовый поиск]]
| |
| ::б) Введите фрагмент комментария или логина его автора.
| |
| ::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти комментарии.
| |
| ::По умолчанию выбраны все группы, проекты, ветки и снимки.
| |
| ::г) Нажмите кнопку '''Поиск'''.
| |
| :Отобразятся результаты поиска.
| |
| :[[File:179 Раздел Поиск. Пример результатов поиска в категории Комментарии к маркерам.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Комментарии к маркерам''']]
| |
| :3. Для поиска по полям:
| |
| ::а) Перейдите на вкладку '''Поиск по полям'''.
| |
| ::[[File:180 Раздел Поиск. Категория Комментарии к маркерам. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Комментарии к маркерам'''. Поиск по полям]]
| |
| ::б) Заполните поля поиска.
| |
| ::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти комментарии.
| |
| ::По умолчанию выбраны все группы, проекты, ветки и снимки.
| |
| ::г) Нажмите кнопку '''Поиск'''.
| |
| :Отобразятся результаты поиска.
| |
| :[[File:181 Раздел Поиск. Пример результатов поиска по полям в категории Комментарии к маркерам.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Комментарии к маркерам''']]
| |
| :4. Для очистки поискового запроса нажмите кнопку '''Очистить'''.
| |
| :5. Чтобы посмотреть подробную информацию о маркере с найденным комментарием, в результатах поиска кликните на ссылку в имени файла с номером строки исходного кода.
| |
| :Найденный маркер с комментарием откроется в [[Help:UI manual#Работа в режиме разметки|режиме разметки]].
| |
| | |
| === Поиск снимков ===
| |
| Чтобы воспользоваться поиском по снимкам:
| |
| :1. Выберите категорию '''Снимки''' раздела '''Поиск'''.
| |
| :2. Для базового поиска:
| |
| ::а) Перейдите на вкладку '''Базовый поиск''' (открыта по умолчанию).
| |
| ::[[File:182 Раздел Поиск. Категория Снимки. Базовый поиск.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Снимки'''. Базовый поиск]]
| |
| ::б) Введите фрагмент названия снимка, пользовательского поля снимка (названия или его значения) или логина пользователя, который импортировал снимок.
| |
| ::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти снимки.
| |
| ::По умолчанию выбраны все группы, проекты, ветки и снимки.
| |
| ::г) Нажмите кнопку '''Поиск'''.
| |
| :Отобразятся результаты поиска.
| |
| :[[File:183 Раздел Поиск. Пример результатов поиска в категории Снимки.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска в категории '''Снимки''']]
| |
| | |
| :3. Для поиска по полям:
| |
| ::а) Перейдите на вкладку '''Поиск по полям'''.
| |
| ::[[File:184 Раздел Поиск. Категория Снимки. Поиск по полям.png|thumb|none|upright=3|Раздел '''Поиск'''. Категория '''Снимки'''. Поиск по полям]]
| |
| ::б) Заполните поля поиска.
| |
| ::в) Выберите (опционально) группу проектов, проект, ветку и снимок, в которых нужно найти снимки.
| |
| ::По умолчанию выбраны все группы, проекты, ветки и снимки.
| |
| ::г) Нажмите кнопку '''Поиск'''.
| |
| :Отобразятся результаты поиска.
| |
| :[[File:185 Раздел Поиск. Пример результатов поиска по полям в категории Снимки.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример результатов поиска по полям в категории '''Снимки''']]
| |
| :4. Для очистки поискового запроса нажмите кнопку '''Очистить'''.
| |
| :5. Чтобы посмотреть подробную информацию о найденном снимке, в результатах поиска кликните на ссылку в пути размещения снимка.
| |
| :Найденный снимок откроется в [[Help:UI manual#Работа в режиме разметки|режиме разметки]] со всеми его маркерами.
| |
| | |
| === Просмотр истории поиска ===
| |
| Чтобы посмотреть историю поиска, нажмите кнопку '''История поиска''' в разделе '''Поиск'''.
| |
| | |
| В истории отображаются 100 последних поисковых запросов пользователя.
| |
| [[File:186 Раздел Поиск. Пример истории поиска.png|thumb|none|upright=3|Раздел '''Поиск'''. Пример истории поиска]]
| |
| | |
| Чтобы повторить поиск из истории, кликните на ссылку с поисковым запросом.
| |
| | |
| == Настройка сервера Svacer ==
| |
| Перейти в раздел '''Настройки''' можно по нажатии кнопки [[File:Icon settings.png|x25px]] в верхней правой части экрана.
| |
| | |
| В этом разделе пользователю, в зависимости от роли, доступны следующие функции:
| |
| * [[Help:UI manual#Управление пользователями, ролями и организациями|управление пользователями, ролями и организациями]];
| |
| * [[Help:UI manual#Настройка глобальных фильтров|настройка глобальных фильтров]];
| |
| * [[Help:UI manual#Управление блокировками разметки|управление блокировками]];
| |
| * [[Help:UI manual#Ведение журнала операций|ведение журнала операций]];
| |
| * [[Help:UI manual#Управление шаблонами разметки|управление шаблонами разметки]];
| |
| * [[Help:UI manual#Управление клиентами OAuth|управление клиентами OAuth]];
| |
| * [[Help:UI manual#Управление токенами доступа|управление токенами доступа]];
| |
| * [[Help:UI manual#Просмотр информации о сервере|просмотр информации о сервере]];
| |
| | |
| | |
| === Управление пользователями, ролями и организациями===
| |
| ==== Управление пользователями ====
| |
| Реестром учетных записей пользователей можно управлять на вкладке '''Пользователи''' в разделе '''Управление пользователями''' страницы '''Настройки'''.<br>
| |
| Для [[LDAP configuration|учетных записей с доступом по LDAP]] рядом с логином отображается индикатор [[File:Icon LDAP.png|x25px]], для учетных записей с доступом по OIDC рядом с логином отображается индикатор [[File:Icon_OIDC.png|x25px]], а для учетных записей с признаком '''Мастер разметки''' – индикатор [[File:Icon markup master.png|x25px]].<br>
| |
| В разделе доступны:
| |
| * поиск по атрибутам учётной записи пользователя;
| |
| * фильтрация списка по типам учётных записей:
| |
| :* все;
| |
| :* системные;
| |
| :* LDAP;
| |
| :* OIDC;
| |
| :* заблокированные;
| |
| :* активные;
| |
| :* по ролям;
| |
| :* по организациям.
| |
| * сортировка по колонкам '''Логин''', '''ФИО''' и '''Дата создания''' (по умолчанию).
| |
| :[[File:74 Вкладка Пользователи на странице Настройки.png|thumb|none|upright=3|Вкладка '''Пользователи''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
| |
| Для управления пользователями:
| |
| :1. Создайте учетную запись пользователя:
| |
| ::а) Нажмите кнопку '''Создать'''.
| |
| ::Откроется окно добавления учетной записи пользователя.
| |
| ::[[File:76 Окно Добавить пользователя.png|thumb|none|upright=1.5|Окно '''Создать пользователя''']]
| |
| ::б) Заполните поля:
| |
| ::* Логин;
| |
| ::* Пароль;
| |
| ::* e-mail;
| |
| ::* ФИО.
| |
| ::в) Выберите [[Help:UI manual#Управление организациями|организации]], в которые должен входить пользователь, а также назначьте ему [[Help:UI manual#Управление ролями|роли]] – выберите значения в раскрывающихся списках полей '''Организации''' и '''Роли''' соответственно. Для отмены выбора нажмите на кнопку [[File:Icon cancel.png|x25px]] справа от значения.
| |
| ::г) Включите опции '''Изменить пароль при первом входе в систему''' и '''Мастер разметки'''.<br>
| |
| ::{{Note|type=info|text=''Если для учётной записи активирована опция '''Мастер разметки''', есть разрешение на разметку и этот пользователь разметил маркер в каком-либо снимке, то изменить его разметку может только пользователь, в учётной записи которого также активирована опция '''Мастер разметки''' или которому предоставлен [[#Cерверные доступы|серверный доступ]] '''Изменение любой разметки'''.''}}
| |
| ::д) Нажмите кнопку '''Создать'''.
| |
| : В таблице со списком пользователей добавится новая запись.
| |
| | |
| :2. Воспользуйтесь функциями в строке учетной записи в крайнем правом столбце – нажмите кнопку [[File:Button menu.png|x25px]] и выберите пункт:
| |
| :* '''Редактировать''' – для перехода к редактированию данных профиля;
| |
| :* '''Изменить пароль''' – для перехода к изменению пароля;
| |
| :* '''Сбросить настройки пользователя''' – для возврата пользовательских настроек к их значениям по умолчанию;
| |
| :* '''Заблокировать''' – для блокировки учетной записи. В этом случае для учетной записи пользователя блокируется доступ к системе, а в списке рядом с логином учетной записи отображается индикатор [[File:Icon_Archived.png|x25px]];
| |
| :* '''Разблокировать''' – для восстановления доступа пользователя к системе;
| |
| :* '''Настройки уведомлений''' – для настройки уведомлений пользователя об операциях со снимками и маркерами – аналогично [[Help:UI manual#Настройка уведомлений|настройке уведомлений в меню пользователя]];
| |
| ::[[File:219 Настройки Настройка уведомлений выбранного пользователя.png|thumb|none|upright=2|Настройки уведомлений выбранного пользователя]]
| |
| :* '''Удалить''' – для удаления учётной записи пользователя;
| |
| :* '''Показать доступы пользователя''' – для отображения списка объединенных доступов всех ролей, назначенных пользователю.
| |
| ::[[File:113 Список доступов пользователя.png|thumb|none|upright=3|Список доступов пользователя]]
| |
| ::{{Note|type=warn|text=''Функции блокировки и удаления недоступны для системных учетных записей. При изменении логина или списка доступов у авторизованного пользователя, он будет перенаправлен на страницу авторизации.''}}
| |
| | |
| :3. Воспользуйтесь функциями управления несколькими учётными записями одновременно:
| |
| ::а) Чтобы выбрать несколько записей, установите флажки в первом столбце списка пользователей.
| |
| ::б) Чтобы выбрать все отображаемые учётные записи, установите один флажок в заголовке столбцов в первом столбце списка.
| |
| ::в) Нажмите кнопку '''Действия''' в верхней части списка пользователей и выберите пункт: '''Сбросить настройки пользователя''', '''Заблокировать''', '''Разблокировать''' или '''Удалить'''. В списке активны только действия, доступные всем выбранным учетным записям.
| |
| :4. Для [[LDAP configuration|учетной записи с доступом по LDAP]] обновите данные – в окне редактирования данных профиля пользователя нажмите кнопку '''Загрузить из LDAP'''.
| |
| :Загрузятся параметры профиля пользователя и его контакты из профиля в службе каталогов, если они там указаны.
| |
| :[[File:78 Загрузка данных из LDAP.png|thumb|none|upright=1.5|Загрузка данных из LDAP]]
| |
| | |
| ==== Управление ролями ====
| |
| Реестром ролей можно управлять на вкладке '''Роли''' в разделе '''Управление пользователями''' страницы '''Настройки'''.
| |
| [[File:79 Переход к управлению ролями.png|thumb|none|upright=3|Вкладка '''Роли''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
| |
| {{Note|type=info|text=''Роли [[Help:UI manual#Описание ролевой модели|admin, filter_master и importer]] являются встроенными с особым значением. Их нельзя удалить или изменить.''}}
| |
| | |
| Доступен поиск по названию роли и сортировка по колонкам '''Название''' (по умолчанию) и '''Пользователи'''. <br>
| |
| Для управления ролями доступны следующие функции:
| |
| :1. Создание новой роли:
| |
| ::а) Нажмите кнопку '''Создать'''.
| |
| ::[[File:81 Окно добавления роли.png|thumb|none|upright=3|Окно добавления роли]]
| |
| ::б) Заполните поля появившейся формы:
| |
| :::*введите название роли;
| |
| :::*в блоке '''Серверные доступы''' выберите доступы – нажмите кнопку '''Выбрать всё''' или установите флажки для активации доступов.
| |
| :::При наведении курсора на иконку [[File:Icon question mark2.png|x25px]] отображается пояснение к доступу.
| |
| :::*в блоке '''Проектные доступы''' выберите тип доступа: группа проектов или определённый проект или его ветка;
| |
| :::*если выбран тип '''Группа проектов''', выберите название группы и установите флажки для активации доступов;
| |
| :::*если выбран тип '''Проект / Ветка''', выберите название проекта или ветки проекта, установите флажки для активации доступов.
| |
| :::Если выбрано значение '''Все''', то доступы будут предоставлены для всех проектов;
| |
| :::*для удаления строки с проектными доступами в блоке '''Проектные доступы''' нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
| |
| ::в) Нажмите кнопку '''Создать'''.
| |
| | |
| :2. Просмотр доступов роли, нажмите на ссылку '''Показать доступы''' в столбце '''Доступы'''.
| |
| :[[File:114 Список доступов роли.png|thumb|none|upright=3|Список доступов роли]]
| |
| | |
| :3. Редактирование роли:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке роли в крайнем правом столбце.
| |
| ::б) В меню выберите пункт '''Редактировать''' и внесите изменения.
| |
| | |
| :4. Создание копии роли:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
| |
| ::б) В меню выберите пункт '''Создать копию'''.
| |
| :В реестр ролей добавится новая запись с именем исходной роли и добавленным порядковым номером копии.
| |
| | |
| :5. Просмотр информации о роли в JSON-формате:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
| |
| ::б) В меню выберите пункт '''Просмотреть JSON'''.
| |
| | |
| :6. Удаление роли:
| |
| ::а) Нажмите кнопку [[File:Button menu.png|x25px]] в строке исходной роли в крайнем правом столбце.
| |
| ::б) В меню выберите пункт '''Удалить'''.
| |
| ::в) Подтвердите удаление.
| |
| | |
| :7. Удаление несколько ролей одновременно:
| |
| ::а) Для выбора нескольких записей установите флажки в первом столбце списка ролей.
| |
| ::б) Чтобы выбрать все записи, установите один флажок в заголовке столбцов в первом столбце списка ролей.
| |
| ::в) Нажмите кнопку '''Удалить''' и подтвердите удаление.
| |
| | |
| ==== Управление организациями ====
| |
| Пользователи могут быть связаны с организациями. Один пользователь может принадлежать нескольким организациям. Организации носят информационный характер и не влияют на права пользователей в системе. <br>
| |
| Реестром организаций можно управлять на вкладке '''Организации''' в разделе '''Управление пользователями''' страницы '''Настройки'''.
| |
| [[File:92 Вкладка Организации на странице Настройки.png|thumb|none|upright=3|Вкладка '''Организации''' в разделе '''Управление пользователями''' страницы '''Настройки''']]
| |
| Доступен поиск по названию и сокращенному названию организации и сортировка по колонкам '''Название''' (по умолчанию), '''Сокращенное название''' и '''Пользователи'''.
| |
| Для управления организациями, доступны следующие функции:
| |
| :1. Создание организации:
| |
| ::а) Нажмите кнопку '''Создать'''.
| |
| ::б) Заполните поля появившейся формы.
| |
| ::в) Нажмите кнопку '''Создать'''.
| |
| ::[[File:93 Окно добавления организации в реестр.png|thumb|none|upright=1.5|Окно добавления организации в реестр]]
| |
| | |
| :2. Редактирование организации:
| |
| ::а) Нажмите кнопку [[File:Icon edit2.png|x25px]] в крайнем правом столбце.
| |
| ::б) В появившейся форме отредактируйте данные организации.
| |
| ::в) Нажмите кнопку '''Сохранить'''.
| |
| | |
| :3. Удаление организации:
| |
| ::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
| |
| ::б) В появившемся диалоге подтвердите удаление, нажав на кнопку '''Удалить'''.
| |
| | |
| :4. Удаление несколько организаций одновременно:
| |
| ::а) Для выбора нескольких записей установите флажки в первом столбце списка организаций.
| |
| ::б) Чтобы выбрать все организации, установите один флажок в заголовке столбцов в первом столбце списка.
| |
| ::в) Нажмите кнопку '''Удалить''' и подтвердите удаление.
| |
| | |
| === Настройка глобальных фильтров ===
| |
| В разделе '''Глобальные фильтры''' страницы '''Настройки''' можно настроить глобальные фильтры, применительно [[Help:UI manual#Выбор контекста (проекта, ветки и снимка)|к выбранным проекту или ветке проекта]]:<br>
| |
| {{Note|type=info|text=''По умолчанию выбран контекст (проект, ветка), заданный ранее в режиме '''Разметка''', '''Код''' или '''Отчеты'''.''}}
| |
| [[File:82 Вкладка Фильтры на странице Настройки.png|thumb|none|upright=4|Раздел '''Глобальные фильтры''' на странице '''Настройки''']]
| |
| | |
| В разделе доступен поиск по названию фильтра.
| |
| | |
| Для настройки фильтров:
| |
| :1. Выберите проект и ветку в верхней строке раздела. По умолчанию указаны проект и ветка, выбранные в разделе '''Разметка'''.
| |
| :2. Чтобы добавить фильтр, нажмите кнопку '''Создать'''.
| |
| :Отобразится новая строка:
| |
| :[[File:83 Новая строка с фильтром.png|thumb|none|upright=4|Новая строка с фильтром]]
| |
| | |
| :3. Чтобы изменить настройки фильтров:
| |
| ::а) Введите или поменяйте название фильтра
| |
| ::б) Включите или выключите фильтр – нажмите на значение в столбце '''Статус''', чтобы отобразилась иконка [[File:Icon check2.png|x25px]] (по умолчанию) или [[File:Icon cross 01.png|x25px]].
| |
| ::в) Выберите область применения фильтра – нажмите на значение в столбце '''Область''' один или два раза, чтобы отобразилось значение '''ветка''' или '''проект'''.
| |
| ::г) Введите [[Help:UI manual#Использование регулярных выражений|регулярное выражение]] или загрузите его из файла в столбцах '''Включить пути по шаблону''', '''Исключить пути по шаблону''' и '''Детекторы'''.
| |
| ::{{Note|type=info|text=''Шаблоны регулярных выражений не зависят от регистра и поддерживают следующий синтаксис:''
| |
| :* ''; – для разделения списков значений;''
| |
| :* ''* – любое количество символов;''
| |
| :* ''? – один произвольный символ;''
| |
| :* ''re: – включая значения, определяемые регулярным выражением;''
| |
| :* ''re!: – исключая значения, определяемые регулярным выражением (только для столбца '''Детекторы''').''}}
| |
| ::д) Выберите уровни серьезности (критичности) и надежности:
| |
| ::* [[File:Icon_critical_on.png|x30px]] – уровень выбран;
| |
| ::* [[File:Icon_critical_off.png|x30px]] – уровень не выбран.
| |
| ::Для изменения выбора нажмите на название уровня.
| |
| :4. Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце, чтобы удалить один фильтр.
| |
| :5. Чтобы удалить несколько фильтров:
| |
| ::а) Для выбора нескольких записей установите флажки в первом столбце списка фильтров.
| |
| ::б) Чтобы выбрать все записи, установите один флажок в заголовке столбцов в первом столбце списка фильтров.
| |
| ::в) Нажмите кнопку '''Удалить'''.
| |
| :6. Для сохранения и применения изменений нажмите кнопку '''Применить'''.
| |
| Если не применить изменения, то при переходе в другой раздел системы отобразится сообщение о том, что изменения не применены:
| |
| :[[File:115 Запрос на изменение глобальных фильтров.png|thumb|none|upright=1.5]]
| |
| | |
| :{{Note|type=warn|text=''После применения глобальных фильтров пользователям, у которых в режиме разметки открыт данный контекст, требуется перезагрузить страницу (нажать клавишу F5) для обновления списка маркеров.''}}
| |
| | |
| === Управление блокировками разметки ===
| |
| Чтобы посмотреть список всех [[Help:UI manual#Блокировка разметки|блокировок]], перейдите на вкладку '''Блокировки''' страницы '''Настройки''':
| |
| [[File:89 Вкладка Блокировки на странице Настройки.png|800px|thumb|none|Раздел '''Блокировки''' страницы '''Настройки''']]
| |
| {{Note|type=info|text=''Пользователю отображается список блокировок в контейнерах, к которым у него есть доступ. Удаление не своих блокировок доступно пользователям с соответствующим доступом.''}}
| |
| | |
| Доступен поиск по контейнерам, заблокированным сущностям и пользователям, сортировка по всем колонкам (по умолчанию – сортировка по дате).
| |
| | |
| Для удаления одной блокировки:
| |
| :1. Нажмите кнопку [[File:Icon delete.png|x25px]] в строке проекта в крайнем правом столбце.
| |
| :2. Подтвердите удаление.
| |
| Для удаления нескольких блокировок:
| |
| :1. Чтобы выбрать для удаления все блокировки, установите флажок в заголовке табличного списка.
| |
| :2. Чтобы выбрать несколько блокировок, установите флажки в крайнем правом столбце табличного списка.
| |
| :3. Нажмите кнопку '''Удалить''' в верхней части списка.
| |
| | |
| === Ведение журнала операций ===
| |
| В разделе '''Журнал операций''' страницы '''Настройки''' доступны просмотр и откат выполнения групповых операций по разметке и комментированию маркеров, таких как импорт разметки, копирование разметки, импорт снимков и т. п.
| |
| [[File:206 Настройки. Журнал операций.png|800px|thumb|none|Раздел '''Журнал операций''' на странице '''Настройки''']]
| |
| В разделе доступны:
| |
| * поиск по названию контейнера, типу операции и её описанию;
| |
| * фильтрация списка:
| |
| ** по статусу операции: '''Applied''', '''Reverted''', '''Invalid''';
| |
| ** типу операции;
| |
| ** генератору операции;
| |
| ** автору операции;
| |
| ** диапазону дат создания операции;
| |
| * сортировка по всем колонкам, кроме '''Описание'''.
| |
| | |
| Чтобы откатить выполнение операции, нажмите кнопку [[File:Icon return.png|x25px]] в строке и подтвердите действие в открывшемся окне.
| |
| {{Note|type=warn|text=''Откат своих операций доступен пользователям с [[#Проектные доступы|проектным доступом]] '''Разметка маркеров'''.<br>Откат операций других пользователей доступен пользователям с [[#Проектные доступы|проектным доступом]] '''Разметка маркеров''' и [[#Серверные доступы|серверным доступом]] '''Администрирование сервера''' или серверным доступами '''Изменение любой разметки''' и '''Изменение любых комментариев'''.''}}
| |
| | |
| === Управление шаблонами разметки ===
| |
| Управление шаблонами разметки доступно в разделе '''Шаблоны разметки''' страницы '''Настройки''':
| |
| [[File:84 Вкладка Шаблоны на странице Настройки.png|thumb|none|upright=3|Раздел '''Шаблоны разметки''' на странице '''Настройки''']]
| |
| | |
| Шаблоны разметки нужны для [[Help:UI manual#Импорт разметки|импорта]]/[[Help:UI manual#Экспорт разметки|экспорта разметки]]. С их помощью комментарии в исходном коде будут преобразовываться в разметку на сервере истории и обратно.
| |
| | |
| Шаблон с именем DEFAULT есть всегда, его нельзя отредактировать или удалить.
| |
| | |
| {{Note|type=info|text=''Для корректного создания или изменения шаблонов разметки следует обратиться к разработчикам Svacer.''}}
| |
| | |
| Для управления шаблонами:
| |
| :1. Нажмите кнопку '''Создать'''.
| |
| :Откроется окно создания шаблона.
| |
| :[[File:Добавление шаблона разметки.png|thumb|none|upright=1.5|Окно создания шаблона разметки]]
| |
| :2. Введите название шаблона.
| |
| :3. Нажмите кнопку '''Создать'''.
| |
| :Шаблон появится в списке шаблонов для разметки в правой панели формы
| |
| :4. Отредактируйте поля шаблона разметки:
| |
| :[[File:85 Поля шаблона, доступные для редактирования.png|thumb|none|upright=2.5|Редактирование шаблона разметки]]
| |
| :5. Нажмите '''Сохранить'''.
| |
| :6. Чтобы клонировать существующий шаблон разметки, нажмите кнопку [[File:Icon_clone.png|x20px]] в правой части строки шаблона в списке.
| |
| :7. Для удаления одного шаблона:
| |
| ::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в правой части строки шаблона в списке.
| |
| ::б) Подтвердите удаление.
| |
| :8. Для удаления нескольких шаблонов:
| |
| ::а) Выберите шаблоны для удаления – установите флажки в левой части названий шаблонов или нажмите кнопку '''Выбрать всё'''.
| |
| ::б) Нажмите кнопку '''Удалить''' в верхней части списка шаблонов и подтвердите удаление.
| |
| | |
| === Управление клиентами OAuth ===
| |
| Svacer поддерживает авторизацию по протоколу OAuth. Для авторизации используются запросы <code>GET /api/oauth/authorize</code> и <code>POST /api/oauth/token</code> в соответствии со стандартом.
| |
| | |
| Управление клиентами доступно в разделе '''Клиенты OAuth''' на странице '''Настройки''':
| |
| [[File:91 Вкладка Клиенты OAuth на странице Настройки.png|thumb|none|upright=3|Раздел '''Клиенты OAuth''' на странице '''Настройки''']]
| |
| Доступен поиск по имени и домену клиента OAuth, сортировка по колонкам '''Название''' (по умолчанию) и '''Домен'''.
| |
| | |
| Для управления клиентами OAuth:
| |
| :1. Создайте клиента OAuth:
| |
| ::а) Нажмите кнопку '''Создать'''.
| |
| ::б) В окне '''Создать клиента OAuth''' введите название и домен.
| |
| ::в) Нажмите кнопку '''Создать'''.
| |
| ::[[File:116 Создание клиента OAuth.png|thumb|none|upright=1.5|Окно '''Создать клиента OAuth''']]
| |
| ::Отобразится окно с секретом клиента.<br>
| |
| ::{{Note|type=warn|text=''Секрет отображается только один раз – при создании клиента''}}
| |
| ::[[File:117 Пример секрета клиента OAuth.png|thumb|none|upright=1.5]]
| |
| ::г) Нажмите кнопку '''Скопировать в буфер обмена''' и сохраните секрет в надежном месте.
| |
| :2. Чтобы скопировать ID клиента OAuth, нажмите кнопку [[File:Icon clone.png|x25px]].
| |
| :3. Для перехода к изменению имени и домена клиента OAuth нажмите кнопку [[File:Icon edit2.png|x25px]] в крайнем правом столбце.
| |
| :4. Для удаления одного клиента OAuth:
| |
| ::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
| |
| ::б) Подтвердите удаление.
| |
| :5. Для удаления нескольких клиентов OAuth:
| |
| ::а) Чтобы выбрать для удаления всех клиентов, установите флажок в заголовке табличного списка.
| |
| ::б) Чтобы выбрать нескольких клиентов, установите флажки в крайнем правом столбце табличного списка.
| |
| ::в) Нажмите кнопку '''Удалить''' в верхней части табличного списка клиентов и подтвердите удаление.
| |
| | |
| === Управление токенами доступа ===
| |
| Управление персональными токенами доступа выполняется в разделе '''Токены доступа''' на странице '''Настройки'''.
| |
| [[File:207 Настройки. Токены доступа.png|800px|thumb|none|Раздел '''Токены доступа''' на странице '''Настройки''']]
| |
| В разделе доступны:
| |
| * поиск по названию токена и его описанию, а также по логину пользователя;
| |
| * сортировка по всем колонкам, кроме '''Описание'''.
| |
| Для управления токенами доступа:
| |
| :1. Создайте токен:
| |
| ::а) Нажмите кнопку '''Создать'''.
| |
| ::б) В окне '''Создать токен доступа''' введите название и, опционально, описание токена; выберите срок действия.
| |
| ::По умолчанию срок действия токена 90 дней (минимальный срок 1 день, максимальный – 365).
| |
| ::в) Нажмите кнопку '''Создать'''.
| |
| ::[[File:208 Окно Создание токена доступа.png|thumb|none|upright=1.5|Окно '''Создать токен доступа''']]
| |
| ::Отобразится окно с токеном доступа.
| |
| ::{{Note|type=warn|text=''Токен отображается только один раз – при создании''}}
| |
| ::[[File:209 Токен доступа.png|thumb|none|upright=1.5|Пример токена]]
| |
| ::г) Нажмите кнопку '''Скопировать в буфер обмена''' и сохраните токен в надежном месте.
| |
| :2. Для удаления одного токена:
| |
| ::а) Нажмите кнопку [[File:Icon delete.png|x25px]] в крайнем правом столбце.
| |
| ::б) Подтвердите удаление.
| |
| :3. Для удаления нескольких токенов:
| |
| ::а) Чтобы выбрать для удаления все токены, установите флажок в заголовке табличного списка.
| |
| ::б) Чтобы выбрать несколько токенов, установите флажки в крайнем правом столбце табличного списка.
| |
| ::в) Нажмите кнопку '''Удалить''' в верхней части табличного списка токенов и подтвердите удаление.
| |
| | |
| === Просмотр информации о сервере ===
| |
| В разделе '''Информация о сервере''' на странице '''Настройки''' отображаются:
| |
| * параметры, с которыми запущен сервер;
| |
| * логи сервера;
| |
| * журнал базы данных.
| |
| | |
| [[File:90 Вкладка Информация о сервере на странице Настройки.png|thumb|none|upright=3|Раздел '''Информация о сервере''' на странице '''Настройки''']]
| |
| | |
| Доступны функции:
| |
| * копирование записей в системном логе и журнале;
| |
| * выгрузка системного лога и журнала в файлы в формате .log
| |
| | |
| == Выход из системы ==
| |
| Для выхода из системы выберите пункт '''Выйти''' в меню пользователя в правом верхнем углу экрана.
| |
| [[File:95 Выход из системы —без VSCode.png|thumb|none|upright=1.5|Выход из системы]]
| |
| | |
| == Использование регулярных выражений ==
| |
| Регулярные выражения можно использовать:
| |
| * для поиска и фильтрации данных [[Help:UI manual#Функции навигационной панели|в навигационной панели]] [[Help:UI manual#Вкладка «Файлы»|на вкладке '''Файлы''']];
| |
| * в окне настройки [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] в блоке '''Файлы''';
| |
| * при [[Help:UI manual#Экспорт исходного кода с разметкой|экспорте кода с разметкой]];
| |
| * при [[Help:UI manual#Настройка глобальных фильтров|настройке глобальных фильтров]];
| |
| * в полях [[Help:UI manual#Глобальный поиск|глобального поиска]].
| |
| | |
| Особенности реализации:
| |
| :1. Поиск происходит только по регулярному выражению. Если требуется найти специальный символ в качестве обычного символа, его нужно экранировать (например, точку: <code>\.</code>)
| |
| :2. При поиске находятся вхождения подстроки в полном пути к файлу (аналогично grep). Если требуется найти по полной строке, используйте символы начала и конца строки: <code>^</code> и <code>$</code>
| |
| :3. Поиск не зависит от регистра символов (case insensitive) и поддерживает следующий синтаксис:
| |
| ::* ; – для разделения списков значений;
| |
| ::* * – любое количество символов;
| |
| ::* ? – один произвольный символ.
| |
| :В окне настройки [[Help:UI manual#Настройка и использование пользовательских фильтров|пользовательских фильтров]] в блоке '''Файлы''' можно применить фильтр как для отображения только маркеров из файлов, которые подходят под паттерн, так и для скрытия таких маркеров. Для переключения между этими режимами используйте кнопки [[File:Icon plus 2.png|x20px]] и [[File:Icon minus 3.png|x20px]], которые расположены рядом с полем ввода. В остальных частях интерфейса следует использовать теги re: и re!:
| |
| | |
| Примеры регулярных выражений при поиске файлов на вкладке '''Файлы''' или в пользовательском фильтре:
| |
| :1. Поиск файлов с текстом <code>sha</code> или <code>md5</code> в любом месте пути или имени файла:
| |
| :<pre>sha|md5</pre>
| |
| :2. Отображение только маркеров из файлов с расширением .c:
| |
| :<pre>.*\.c$</pre>
| |
| :3. Скрытие маркеров из файлов, имя которых начинается с символа <code>q</code> и которые имеют расширения .с или .сс:
| |
| ::а) Используйте выражение <code>/q[^/]*\.c$|/q[^/]*\.cc$</code>
| |
| ::б) Нажмите кнопку [[File:Icon plus 2.png|x20px]] рядом с полем ввода, чтобы она поменялась на [[File:Icon minus 3.png|x20px]]
| |
| :4. Отображение только маркеров из файлов, которые имеют текст <code>string</code> в конце имени файла и с расширением из одного символа:
| |
| :<pre>/.*string\..$</pre>
| |
| :5. Скрытие маркеров из файлов в директориях <code>asn1</code> и <code>pem</code>:
| |
| ::а) Используйте выражение <code>/asn1/|/pem/</code>
| |
| ::б) Нажмите кнопку [[File:Icon plus 2.png|x20px]] рядом с полем ввода, чтобы она поменялась на [[File:Icon minus 3.png|x20px]]
| |
| :6. Отображение только маркеров из файлов, которые имеют в имени три цифры подряд:
| |
| :<pre>.*/.*[0-9]{3}[^/]*$</pre>
| |
| :где <code>[^/]*$</code> означает, что после трех цифр и до конца строки может встречаться любой символ, кроме <code>/</code>. Это позволяет исключить директории, имеющие три цифры в названии.
| |
| | |
| == Описание ролевой модели ==
| |
| === Серверные доступы ===
| |
| {| class="wikitable"
| |
| ! Полномочие (доступ) !! Описание !! Влияние на графический интерфейс !! admin !! filter_master !! importer
| |
| |-
| |
| | Создание проектов
| |
| || Создание и клонирование проектов. Пользователь, создавший проект, имеет полный доступ к управлению этим проектом
| |
| || Наличие полномочия делает доступным:
| |
| * раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
| |
| * кнопку '''Создать проект''';
| |
| * форму создания, клонирования и редактирования проекта.
| |
| | |
| Наличие доступа предоставляет автору проекта полные права на управление своими проектами, включая разметку (даже при отсутствии у него соответствующего проектного доступа), а также позволяет удалять приложения к снимкам в созданных проектах
| |
| || + || – || –
| |
| | |
| |-
| |
| | Настройка групп проектов
| |
| || Создание, редактирование и удаление групп проектов
| |
| || Наличие полномочия делает доступным:
| |
| * раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']] с кнопкой для перехода к настройке групп;
| |
| * панель [[Help:UI manual#Работа с группами проектов|'''Группы проектов''']] с полным списком проектов в группах.
| |
| Наличие доступа предоставляет права на просмотр маркеров во всех проектах
| |
| || + || – || –
| |
|
| |
| |-
| |
| | Управление пользователями
| |
| || Создание, редактирование и удаление пользователей
| |
| || Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление пользователями|'''Пользователи''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления учетными записями пользователей
| |
| || + || – || –
| |
|
| |
| |-
| |
| | Управление ролями
| |
| || Создание, редактирование и удаление ролей
| |
| || Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление ролями|'''Роли''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления ролями
| |
| || + || – || –
| |
| | |
| |-
| |
| | Управление организациями
| |
| || Создание, редактирование и удаление организаций
| |
| || Наличие полномочия делает доступной вкладку [[Help:UI manual#Управление организациями|'''Организации''']] в разделе [[Help:UI manual#Управление пользователями, ролями и организациями|'''Настройки – Управление пользователями''']] со всеми функциями управления организациями
| |
| || + || – || –
| |
| | |
| |-
| |
| | Управление шаблонами разметки
| |
| || Создание, редактирование и удаление шаблонов разметки
| |
| || Наличие полномочия делает доступным раздел [[Help:UI manual#Управление шаблонами разметки|'''Настройки – Шаблоны разметки''']] со всеми функциями управления учетными записями шаблонами
| |
| || + || – || –
| |
| | |
| |-
| |
| | Удаление блокировок
| |
| || Просмотр и удаление блокировок всех пользователей
| |
| || Наличие полномочия позволяет просматривать и удалять блокировки всех пользователей в разделе [[Help:UI manual#Управление блокировками разметки|'''Настройки – Блокировки''']]
| |
| || + || – || –
| |
| | |
| |-
| |
| | Управление клиентами OAuth
| |
| || Создание, редактирование и удаление клиентов OAuth
| |
| || Наличие полномочия делает доступным раздел [[Help:UI manual#Управление клиентами OAuth|'''Настройки – Клиенты OAuth''']] со всеми функциями управления клиентами OAuth
| |
| || + || + || +
| |
| | |
| |-
| |
| | Администрирование сервера
| |
| || Просмотр настроек сервера, системных лог-файлов и выполнение операций по администрированию сервера Svacer
| |
| || Наличие полномочия делает доступным раздел [[Help:UI manual#Просмотр информации о сервере|'''Настройки – Информация о сервере''']]
| |
| Совместно с проектными доступами '''Управление ветками''' и снимками и '''Разметка маркеров''' становится доступна функция очистки разметки и комментариев в ветке
| |
| || + || – || –
| |
| | |
| |-
| |
| | Управление публичными фильтрами
| |
| || Публикация, редактирование и удаление публичных фильтров
| |
| || Наличие полномочия позволяет публиковать сохраненные фильтры, а также редактировать и удалять публичные фильтры
| |
| || + || – || –
| |
| | |
| |-
| |
| | Изменение любой разметки
| |
| || Изменение любой разметки маркеров, включая выполненную пользователями с признаком [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']]
| |
| || Доступ позволяет переразмечать маркеры (добавлять новую разметку), которые разметили любые пользователи, в том числе те, для которых активирована опция [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']].
| |
| При этом:
| |
| # Полномочие не предоставляет доступ ко всем проектам. Т. е. пользователь с таким полномочием может изменять разметку только в проектах, к которым у него имеется доступ.
| |
| # Для переразметки маркеров пользователю должен быть предоставлен проектный доступ '''Разметка маркеров'''.
| |
| # Чтобы переразметить заблокированный маркер, сначала нужно [[Help:UI manual#Блокировка разметки маркеров|снять его блокировку]]
| |
| || + || – || –
| |
| | |
| |-
| |
| | Изменение любых комментариев
| |
| || Редактирование и удаление любых пользовательских комментариев к маркерам
| |
| || Доступ позволяет изменять/удалять комментарии, которые создали любые пользователи, в том числе те, для которых активирована опция [[Help:UI manual#Управление пользователями, ролями и организациями|'''Мастер разметки''']].
| |
| При этом:
| |
| # Полномочие не предоставляет доступ ко всем проектам. Т. е. пользователь с таким полномочием может изменять разметку только в проектах, к которым у него имеется доступ.
| |
| # Для добавления комментариев пользователю должно быть предоставлено проектное полномочие '''Разметка маркеров'''.
| |
| # Чтобы поменять комментарий к заблокированному маркеру, сначала нужно [[Help:UI manual#Блокировка разметки маркеров|снять его блокировку]]
| |
| || + || – || –
| |
| | |
| |-
| |
| | Создание резервных копий
| |
| || Создание, просмотр и восстановление резервных копий в интерфейсе командной строки
| |
| || –
| |
| || + || – || –
| |
| | |
| |-
| |
| | Запуск скриптов
| |
| || Запуск скриптов (hooks) по кнопке, расположенной на вкладке '''Подробности''' в правой панели, содержащей информацию о маркере
| |
| || Наличие полномочия добавляет строку '''Хуки''' на вкладке '''Подробности''' правой панели с возможностью запуска скриптов
| |
| || + || – || –
| |
| |}
| |
| | |
| === Проектные доступы===
| |
| {| class="wikitable"
| |
| ! Полномочие (доступ) !! Описание !! Влияние на графический интерфейс !! admin !! filter_master !! importer
| |
| |-
| |
| | Управление проектом и его ветками
| |
| || Редактирование и удаление проекта, включая операции по управлению ветками и снимками проекта, настройке глобальных фильтров, импорту/экспорту разметки и просмотру маркеров
| |
| || Наличие полномочия делает доступным:
| |
| * раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
| |
| * все функции управления проектом (проектами в группе) и его содержимым (за исключением разметки маркеров) – т. е. все операции с проектом, ветками и снимками.
| |
| Наличие полномочия позволяет удалять приложения к снимкам и экспортировать разметку с исходным кодом
| |
| || + || – || –
| |
| | |
| |-
| |
| | Управление ветками и снимками
| |
| || Редактирование и удаление ветки проекта, включая операции по управлению снимками, настройке глобальных фильтров, импорту/экспорту разметки и просмотру маркеров
| |
| || Наличие полномочия делает доступным:
| |
| * раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
| |
| * все функции управления веткой и снимками проекта (за исключением разметки маркеров) – т. е. доступны все операции с веткой и снимками, но не операции управления проектом.
| |
| Наличие полномочия позволяет удалять приложения к снимкам и экспортировать разметку с исходным кодом.
| |
| Запрещено клонировать ветку при наличии доступа только к этой ветке
| |
| || + || – || –
| |
| | |
| |-
| |
| | Настройка глобальных фильтров
| |
| || Создание, редактирование и удаление глобальных фильтров
| |
| || Наличие полномочия делает доступным раздел [[Help:UI manual#Настройка глобальных фильтров|'''Настройки – Глобальные фильтры''']].
| |
| Список проектов и веток в разделе определяется полномочиями к этим проектам и веткам
| |
| || + || + || –
| |
| | |
| |-
| |
| | Импорт снимков
| |
| || Загрузка, редактирование названия и удаление снимков
| |
| || Наличие полномочия делает доступным:
| |
| * раздел [[Help:UI manual#Управление проектами и группами проектов|'''Проекты''']];
| |
| * функции просмотра проекта и ветки, управления снимками в указанной ветке (включая импорт .svace-dir, SARIF и *.snap), просмотра маркеров в указанном контейнере
| |
| || + || – || +
| |
| | |
| |-
| |
| | Импорт разметки
| |
| || Импорт разметки из файла и комментариев в исходном коде
| |
| || Наличие полномочия делает доступным импорт разметки из файла, импорт разметки из комментариев исходного кода снимка и просмотр маркеров в указанном контейнере
| |
| || + || – || +
| |
| | |
| |-
| |
| | Экспорт снимков
| |
| || Экспорт данных снимков с разметкой и их открытие в IDE
| |
| || Наличие полномочия позволяет:
| |
| | |
| * экспортировать разметку с исходными кодами;
| |
| * экспортировать снимки в форматах *.snap и SARIF;
| |
| * просматривать код с маркерами в Web-IDE
| |
| || + || – || +
| |
| | |
| |-
| |
| | Просмотр маркеров
| |
| || Просмотр маркеров и кода снимков, просмотр блокировок маркеров
| |
| || Наличие полномочия предоставляет доступ к следующим функциям [[Help:UI manual#Работа в режиме разметки|в режиме разметки]]:
| |
| * просмотр и выбор снимков в указанном контейнере;
| |
| * просмотр содержимого снимков и маркеров (без возможности разметки).
| |
| Также наличие полномочия предоставляет доступ к разделу [[Help:UI manual#Управление блокировками разметки|'''Настройки – Блокировки''']], но только в части просмотра блокировок в доступных контейнерах, без возможности их удаления
| |
| || + || + || +
| |
| | |
| |-
| |
| | Разметка маркеров
| |
| || Просмотр и разметка маркеров в снимках, включая добавление комментариев, управление списком блокировок
| |
| || Наличие полномочия позволяет пользователю размечать маркеры в указанном контейнере, добавлять комментарии, управлять своими блокировками, т. е. для собственных блокировок доступны кнопки удаления, а блокировки других пользователей доступны только для просмотра.
| |
| При отсутствии полномочия в таблице маркеров недоступны поля для установки флажков, а кнопка групповой разметки – неактивна
| |
| || + || – || –
| |
| | |
| |-
| |
| | Report API
| |
| || Использование Report API для получения статистических показателей
| |
| || –
| |
| || + || – || –
| |
| |}
| |
| | |
| === Известные ограничения ===
| |
| | |
| * Управление ''своими'' проектами для пользователей только c серверной ролью "Create Projects" без дополнительных прав может не работать для проектов, созданных до Release 7-0-0.
| |
| : Workaround: добавить пользователю явно проектные доступы на каждый необходимый проект.
| |
