Project

General

Profile

Reqeditor-getting-started » History » Version 70

Yuriy Shekochihin, 01/11/2010 04:02 PM

1 15 Илья Рудаков
h1. Getting started with ReqEditor
2 1 Yuriy Shekochihin
3 4 Yuriy Shekochihin
ReqEditor является инструментом для организации каталога требований. Этот инструмент выполнен в виде расширения для Eclipse. 
4 2 Yuriy Shekochihin
5
Найти подробную информацию о ReqEditor можно по адресу: http://forge.ispras.ru/projects/show/reqdb
6
7 30 Илья Рудаков
h2. 1. Установка
8 1 Yuriy Shekochihin
9 68 Alexey Demakov
Для работы ReqEditor требуется установленный Eclipse. Если у Вас уже установлен Eclipse следующий пункт можно пропустить.
10 5 Yuriy Shekochihin
11 16 Илья Рудаков
h3. 1.1 Системные требования
12 1 Yuriy Shekochihin
13 70 Yuriy Shekochihin
* Firefox 3.5 или выше ( http://www.mozilla.com/ );
14
* Eclipse Classic 3.5 или выше ( http://www.eclipse.org/downloads/ );
15
* XULRunner 1.9 или выше ( https://developer.mozilla.org/En/XULRunner );
16 2 Yuriy Shekochihin
17 16 Илья Рудаков
h3. 1.2 Установка Eclipse
18 1 Yuriy Shekochihin
19 30 Илья Рудаков
Eclipse можно скачать, зайдя на сайт http://eclipse.org/
20 2 Yuriy Shekochihin
21 16 Илья Рудаков
h3. 1.3 Установка ReqEditor
22 2 Yuriy Shekochihin
23 32 Илья Рудаков
Для установки ReqEditor необходимо скачать последнюю версию расширения с "сайта проекта":http://forge.ispras.ru/projects/list_files/reqdb и распаковать архив в директорию: 
24 56 Илья Рудаков
<pre>%ECLIPSE%/dropins</pre> где %%ECLIPSE%% - путь к Eclipse IDE.
25 1 Yuriy Shekochihin
26 19 Илья Рудаков
27 21 Илья Рудаков
h2. 2. Разметка требований
28 20 Илья Рудаков
29 34 Илья Рудаков
Рассмотрим подробнее работу инструмента на примере требований к функции g_array_sized_new()
30 2 Yuriy Shekochihin
библиотеки glib.
31
32 20 Илья Рудаков
h3. 2.1 Подготовка к работе
33 1 Yuriy Shekochihin
34 63 Илья Рудаков
Перед началом работы необходимо открыть перспективу ReqEditor. Для этого нажмите на значок "Open Perspective", находящийся в верхнем правом углу, как показано на следующем рисунке.
35 1 Yuriy Shekochihin
36 60 Илья Рудаков
!choose_persp1.png!
37 23 Илья Рудаков
38 63 Илья Рудаков
Далее выберите "Other..."
39 11 Yuriy Shekochihin
40 61 Илья Рудаков
!choose_persp2.png!
41 11 Yuriy Shekochihin
42 64 Илья Рудаков
Появится диалоговое окно, в котором нужно выбрать ReqEditor и после нажать кнопку "OK", как показано на рисунке ниже.
43 24 Илья Рудаков
44 60 Илья Рудаков
!select-persp-dialog.png!
45 24 Илья Рудаков
46 65 Илья Рудаков
В перспективе ReqEditor по умолчанию открыты отображения "Documents" и "Requirements". В "Documents" будет отображаться дерево документов, в "Requirements" - дерево требований.
47 11 Yuriy Shekochihin
48 60 Илья Рудаков
!persp-view.png!
49 11 Yuriy Shekochihin
50 20 Илья Рудаков
h3. 2.2 Создание нового каталога
51 1 Yuriy Shekochihin
52 26 Илья Рудаков
Теперь нам нужно создать каталог требований. Под каталогом требований мы будем понимать контейнер, в котором хранятся документы и требования. Чтобы создать каталог требований, зайдите в File -> New -> Other, как показано ниже.
53 25 Илья Рудаков
54 1 Yuriy Shekochihin
!Catalog-call-wizards.png!
55 26 Илья Рудаков
56 27 Илья Рудаков
Вы увидите диалоговое окно. Выберите Unitesk Wizards -> Catalogue of Requirements  и нажмите Next.
57 10 Yuriy Shekochihin
58 1 Yuriy Shekochihin
!Catalog-select-wizard.png!
59 27 Илья Рудаков
60
В следующем диалоговом окне нужно указать имя каталога. В нашем примере мы назвали его "Glib-Catalogue". Жмем Finish.
61 9 Yuriy Shekochihin
62
!Catalog-_wizard_creates_new_cat.png!
63
64 12 Yuriy Shekochihin
В итоге должно получиться следующее:
65
66
!cat-after-creation.png!
67
68 20 Илья Рудаков
h3. 2.3 Импорт документа в каталог
69 1 Yuriy Shekochihin
70 66 Илья Рудаков
<pre>
71
В данный момент инструмент ReqEditor позволяет работать с документами в кодировке UTF-8.
72
</pre>
73
74 57 Илья Рудаков
Теперь нужно добавить документ в каталог. Для этого в Documents нажимаем правой кнопкой мыши на каталог требований "Glib-Catalogue". В появившемся меню выбираем "Import here".
75 53 Илья Рудаков
76 52 Илья Рудаков
!Doc-import-call.png!
77 53 Илья Рудаков
78 67 Илья Рудаков
В диалоговом окне в поле "Import file:" указываем путь к документу с помощью кнопки "Browse...". В нашем примере это "glib-Arrays.html":http://forge.ispras.ru/attachments/113/glib-Arrays-utf8.html.
79 53 Илья Рудаков
В поле "Save to:" при помощи кнопки "Browse..." указываем путь к папке Documents, которая находится в каталоге требований "Glib-Catalogue".
80
81 54 Илья Рудаков
!Doc-import-dialog.png!
82 53 Илья Рудаков
83
Чтобы открыть документ, добавленный в каталог требований, нужно двойным щелчком мыши нажать на название документа в отображении Documents, как показано ниже. Чтобы функционал разметки документа работал, важно открывать документы именно через отображение "Documents", а не через отображение "Project Explorer"!
84
85 52 Илья Рудаков
!Doc-open.png!
86 2 Yuriy Shekochihin
87 40 Илья Рудаков
h3. 2.4 Создание требований
88 1 Yuriy Shekochihin
89 42 Илья Рудаков
Теперь давайте создадим простую иерархию требований. Для этого перейдем в "Requirements", выделим каталог требований "Glib-Catalogue" и нажмем на правую кнопку мыши. Далее нажимаем на "Add requirement", как показано ниже.
90 40 Илья Рудаков
91 1 Yuriy Shekochihin
!Req-new-call.png!
92 42 Илья Рудаков
93
Появится диалоговое окно, в котором нужно указать имя требования. В нашем примере это "g_array_sized_new".
94
95 1 Yuriy Shekochihin
!Req-set-name.png!
96 42 Илья Рудаков
97
Следующий шаг - аналогичным образом добавим дочерние требования с именами: "01", "02", "03" и "04" к "g_array_sized_new". 
98
99 41 Илья Рудаков
!Req-new-call2.png!
100 40 Илья Рудаков
101
h3. 2.5 Добавление выделенного текста из документа в требование
102
103 35 Илья Рудаков
Выберите в Documents нужный вам документ и двойным щелчком мыши откройте его. Далее выделите текст в документе, как показано ниже.
104
105
!Req7.png!
106
107
После того как текст выделен нажмите правую кнопку мыши и выберете "Add to requirement...".
108
109
!Req9.png!
110
111 38 Илья Рудаков
Появится диалоговое окно, в котором вы можете выбрать к какому требованию добавить выделенный текст. В нашем примере мы добавляем текст к требованию g_array_sized_new.01.
112
113
!Req-select.png!
114
115 49 Илья Рудаков
После нажатия кнопки "OK", выбранный текст будет подсвечен желтым цветом в документе, как показано ниже.
116 36 Илья Рудаков
117 1 Yuriy Shekochihin
!Req.png!
118 49 Илья Рудаков
119 50 Илья Рудаков
Аналогичным образом размечаем еще три текстовых сегмента и добавляем их в требования g_array_sized_new.02, -03 и -04 соответственно. Сохраняем документ. После сохранения все размеченные текстовые фрагменты будут добавлены в базу требований.
120 49 Илья Рудаков
121
!Doc-save.png!
122 36 Илья Рудаков
123 43 Илья Рудаков
h3. 2.6 Удаление размеченного текста из требования
124 1 Yuriy Shekochihin
125 43 Илья Рудаков
Чтобы удалить размеченный текст из требования, достаточно один раз кликнуть мышью по тексту. Текст поменяет цвет с желтого на розовый. Это значит, что вы, таким образом, выбрали именно этот участок текста.
126 44 Илья Рудаков
После этого нажмите правую кнопку мыши и выберите "Remove from requirement".
127
128
!Req10.png!
129 43 Илья Рудаков
130 45 Илья Рудаков
h3. 2.7 Редактирование требований
131 1 Yuriy Shekochihin
132 47 Илья Рудаков
Чтобы открыть окно редактирования требования, нужно в Requirements выбрать нужное требование и двойным щелчком мыши его открыть.
133
В открывшемся окне вы увидите раздел "Main information". Здесь указана информация об id требования, об всех размеченных текстовых фрагментах из документа( поле "Description" ) и т.д.
134
135 1 Yuriy Shekochihin
!Req11.png!
136 47 Илья Рудаков
137
Вы можете добавить к требованию альтернативное описание в поле "Alternative description".
138
139 1 Yuriy Shekochihin
!Req-edit-desc.png!
140
141 48 Илья Рудаков
Так же, в графе "Additional information" вы можете добавить предикаты и атрибуты.
142 47 Илья Рудаков
143
!Req-erit-attr-pred.png!
144 9 Yuriy Shekochihin
145 28 Илья Рудаков
h2. 3. Генерация отчета
146
147 1 Yuriy Shekochihin
Итак, мы дошли до генерации отчета о покрытии. Наведите курсор на название каталога требований во вкладке Requirements и нажмите на правую кнопку мыши - появится всплывающие меню. Выберите Generate Report, как показано ниже.
148 9 Yuriy Shekochihin
149 29 Илья Рудаков
!RepGen-call.png!
150
151
Появится диалоговое окно. 
152
В нем четыре пункта для ввода:
153
# *Root* - определяет корневое требование в вашей иерархии требований;
154
# *Data* - путь к шаблону FreeMarker. Файл с расширением .ftl;
155
# *Template* - путь к файлу template.xml;
156 8 Yuriy Shekochihin
# *Save to* - путь к директории куда мы хотим сохранить получившийся отчет.
157 1 Yuriy Shekochihin
158
!RepGen-dialog.png!