Reqeditor-getting-started » History » Revision 36
Revision 35 (Илья Рудаков, 12/17/2009 04:01 PM) → Revision 36/76 (Илья Рудаков, 12/17/2009 04:10 PM)
h1. Getting started with ReqEditor
ReqEditor является инструментом для организации каталога требований. Этот инструмент выполнен в виде расширения для Eclipse.
Найти подробную информацию о ReqEditor можно по адресу: http://forge.ispras.ru/projects/show/reqdb
h2. 1. Установка
Для работы ReqEditor требуется установленный Eclipse. Если у Вас уже установлен Eclispe следующий пункт можно пропустить.
h3. 1.1 Системные требования
* Firefox 3.5 или выше;
* Eclipse 3.5 или выше;
h3. 1.2 Установка Eclipse
Eclipse можно скачать, зайдя на сайт http://eclipse.org/
h3. 1.3 Установка ReqEditor
Для установки ReqEditor необходимо скачать последнюю версию расширения с "сайта проекта":http://forge.ispras.ru/projects/list_files/reqdb и распаковать архив в директорию:
<pre>%ECLIPSE%/dropinst</pre>, где %%ECLIPSE%% - путь к Eclipse IDE.
h2. 2. Разметка требований
Рассмотрим подробнее работу инструмента на примере требований к функции g_array_sized_new()
библиотеки glib.
h3. 2.1 Подготовка к работе
Перед началом работы необходимо открыть вкладки Documents и Requirements. Для этого нужно открыть Window -> Show View -> Other, как показано на следующем рисунке.
!Views-menu-path.png!
Перед вами появится диалоговое окно. Выберите Requirement Editor -> Requirements.
!Views-show-reqs.png!
Повторите туже операцию, но теперь выберете Documents.
!Views-show-docs.png!
После выполнения данных операций в основном окне Eclipse появятся две вкладки: Requirements и Documents. В первой вкладке будет отображаться иерархия требований, во второй - документы. Расположите эти вкладки так, как вам будет удобно. Например, как на рисунке ниже.
!Views-result.png!
h3. 2.2 Создание нового каталога
Теперь нам нужно создать каталог требований. Под каталогом требований мы будем понимать контейнер, в котором хранятся документы и требования. Чтобы создать каталог требований, зайдите в File -> New -> Other, как показано ниже.
!Catalog-call-wizards.png!
Вы увидите диалоговое окно. Выберите Unitesk Wizards -> Catalogue of Requirements и нажмите Next.
!Catalog-select-wizard.png!
В следующем диалоговом окне нужно указать имя каталога. В нашем примере мы назвали его "Glib-Catalogue". Жмем Finish.
!Catalog-_wizard_creates_new_cat.png!
В итоге должно получиться следующее:
!cat-after-creation.png!
h3. 2.3 Импорт документа в каталог
Правый клик -> Импорт...
h3. 2.4 Добавление выделенного текста из документа в требование
Выберите в Documents нужный вам документ и двойным щелчком мыши откройте его. Далее выделите текст в документе, как показано ниже.
!Req7.png!
После того как текст выделен нажмите правую кнопку мыши и выберете "Add to requirement...".
!Req9.png!
Выбранный текст будет добавлен в требование и подсвечен желтым цветом в документе.
!Req.png!
** Выбрать документ
* Выделить нужный текст
* Добавить его в новое требование
* Добавить к существующему требованию новый текст
* Удалить старый текст из требования
h3. 2.5 Работа с требованиями
* Редактирование альтернативного описания требования
* Управление атрибутами требования
* Указание предиката требования
* Создание нового требования
* Удаление требования
h2. 3. Генерация отчета
Итак, мы дошли до генерации отчета о покрытии. Наведите курсор на название каталога требований во вкладке Requirements и нажмите на правую кнопку мыши - появится всплывающие меню. Выберите Generate Report, как показано ниже.
!RepGen-call.png!
Появится диалоговое окно.
В нем четыре пункта для ввода:
# *Root* - определяет корневое требование в вашей иерархии требований;
# *Data* - путь к шаблону FreeMarker. Файл с расширением .ftl;
# *Template* - путь к файлу template.xml;
# *Save to* - путь к директории куда мы хотим сохранить получившийся отчет.
!RepGen-dialog.png!