Project

General

Profile

ExplorerView » History » Version 52

Viktoria Kopach, 06/09/2011 01:40 PM

1 1 Viktoria Kopach
h1. Requality Explorer View
2 2 Viktoria Kopach
3 28 Alexey Khoroshilov
{{toc}}
4
5 1 Viktoria Kopach
Requality Explorer содержит все проекты, что и PackageExplorer, но развернуть можно только проекты типа Requality.
6
В Requality-проекте есть две папки: Documents и Requirements (содержащие, соответственно, документы с требованиями и сами требования).
7
8 39 Viktoria Kopach
h2. Кнопка Link with editor
9 40 Viktoria Kopach
10 39 Viktoria Kopach
Кнопка Link with editor, она же "стрелочки", должна иметь следующую функциональность:
11
- если эта кнопка включена, то при переключении между документами в Markup editor тот документ, вкладка которого открыта, выделяется в Requality explorer''е.
12
- если кнопка выключена, то переключение между вкладками документов в Markup editor не влияет на requality explorer.
13
14 15 Viktoria Kopach
h2. Папка проекта
15
16 41 Viktoria Kopach
(Перспектива Requality, Requality Explorer view)
17
Контекстное меню проекта:
18 42 Viktoria Kopach
* меню *New*, подменю Project.... Это стандартное окно создания проекта в Eclipse, но в нем по умолчанию будет выбран тип проекта - Requality. 
19 45 Viktoria Kopach
Создается папка проекта. По умолчанию в ней отображаются основная папка для документов Documents и основной узел требований Requirements. В основном контекстное меню папки проекта аналогично стандартному контекстному меню проекта в Eclipse.
20 1 Viktoria Kopach
* меню *Delete*   - Удаление проекта в перспективе Requality.
21 51 Viktoria Kopach
В контекстном меню проекта Requality есть пункт Delete с пиктограммой-крестиком (как у аналогичного меню в других перспективах Eclipse).
22 43 Viktoria Kopach
При выборе Delete возникает окно Delete Project с уточняющим вопросом об удалении проекта. В окне есть: 
23
** кнопка Cancel. При выборе Cancel окно закрывается, никаких изменений не происходит. 
24
** кнопка ОК. При выборе OK проект удаляется.
25
** чек-бокс для выбора удаления проекта с диска.
26 42 Viktoria Kopach
По умолчанию проект удаляется из Eclipse, но сохраняется на диске. Если выбран вышеупомянутый чек-бокс (стоит галочка), то проект удаляется с диска.
27 44 Viktoria Kopach
28 45 Viktoria Kopach
Таким образом удаление будет реализовано по аналогии со стандартным удалением проекта в Eclipse.
29 1 Viktoria Kopach
!http://forge.ispras.ru/attachments/692/Delete_Project.png!
30 49 Viktoria Kopach
31 52 Viktoria Kopach
* меню *Rename* позволяет переименовать проект
32
* меню *Move* позволяет переместить проект в другое место на диске.
33
В стандартном контекстном меню проекта в Eclipse есть пункт Refactor, содержащий подпункты Rename и Move. В случае requality было решено обойтись без полноценного Refactor и вынести Rename и Move в основной список пунктов контекстного меню. Но работают они аналогично.
34 47 Viktoria Kopach
35 49 Viktoria Kopach
Меню *Rename Project*:
36 26 Viktoria Kopach
Открывается окно Rename Project. 
37 27 Viktoria Kopach
В нем есть редактируемое поле *New name:*, в котором изначально находится текущее имя проекта, отмеченное выделением. 
38
Есть две кнопки *OK* и *Cancel*. По умолчанию кнопка OK не активна, Сancel - активна.
39 26 Viktoria Kopach
Корректность имени проекта:
40
* Если в поле New name: вводится имя, которое совпадает с текущим именем проекта или с именем другого проекта или папки, находящихся в той же директории, что и текущий проект, то кнопка OK становится неактивной и в окне появляется сообщение красными буквами "А file or folder with this name already exists".
41 1 Viktoria Kopach
* Если в поле New name: пусто или есть знаки, которые не могут быть в имени проекта, то кнопка OK становится неактивной и в окне появляется сообщение красными буквами "This is an invalid name for a file or folder".
42 48 Viktoria Kopach
* В остальных случаях кнопка OK активна.
43 47 Viktoria Kopach
44 26 Viktoria Kopach
45 5 Viktoria Kopach
h2. Documents
46 4 Viktoria Kopach
47 38 Viktoria Kopach
В папке Documents элементы должны быть упорядочены следующим образом: сначала идут все папки в алфавитном порядке, потом все документы из текущей папки в алфавитном порядке.
48 29 Alexey Khoroshilov
49 5 Viktoria Kopach
h3. Действия с документами:
50 1 Viktoria Kopach
51 4 Viktoria Kopach
При *двойном клике на документ* он открывается в редакторе Markup editor.
52
53
*Контекстное меню документов* (по клику правой кнопки) содержит пункты:
54 49 Viktoria Kopach
* Remove Document - удаление документа. 
55 4 Viktoria Kopach
* Update Document - обновляет старую версию документа новой.
56
* HTML Headers Document Processor - создается требование для каждого тега <h#>...</h#>.
57
58 1 Viktoria Kopach
Замечание: Update Document и HTML Headers Document Processor - это вызов обработок, набор которых может расширяться.
59
60
*Create Folder*
61
При создании новой папки открывается окно с полем для ввода имени новой папки и кнопками OK и Cancel.  При  нажатии OK папка с заданным именем создается. При нажатии Cancel окно создания папки просто закрывается, никаких изменений не происходит. При папка с введенным именем уже существует на том же уровне иерархии, в окне создания папки появляется предупреждение об этом и кнопка OK становится неактивной.
62
63
*Remove Document*
64 49 Viktoria Kopach
При этом возникает окно для подтверждения удаления документа. В окне есть две кнопки ОК и Cancel. 
65 50 Viktoria Kopach
** При нажатии Cancel окно закрывается, документ не удаляется. 
66
** При выборе ОК окно закрывается, процесс удаления продолжается: 
67
*** если в документе нет размеченных location''ов, происходит удаление документа; 
68
*** если в документе есть размеченные location''ы, то возникает окно, которое об этом предупреждает и спрашивает, продолжать ли удаление. В окне есть две кнопки ОК и Cancel. 
69
**** При нажатии Cancel окно закрывается, документ не удаляется.
70
**** При выборе ОК окно закрывается, документ удаляется.
71 49 Viktoria Kopach
72
Location''ы, которые были в удаленном документе, удаляются из базы данных и из требований, в которых они находились. Сами требования не удаляются.
73 36 Alexey Khoroshilov
После удаления документа активным элементом в Requality Explorer становится родительский элемент удаленного документа.
74 45 Viktoria Kopach
75 4 Viktoria Kopach
*Update Document*
76
Обновить документ можно только документом, который добавлен в проект. При выборе этого пункта меню на текущем документе (назовем его обновляемым) открывается окно со списком всех документов (иерархически отсортированных по папкам) данного проекта для выбора обновляющего документа. Окно содержит кнопки OK (изначально неактивна) и Cancel. При  нажатии Cancel окно выбора документа закрывается и никаких изменений не происходит. При выборе обновляющего документа кнопка OK становится активна, при ее нажатии происходит обновление обновляемого документа (на котором был нажат пункт меню Update Document) выбранным документом. При этом содержимое обновляемого документа заменяется на содержимое обновляющего документа. Если location''ы, которые уже были размечены в старом документе, есть и в обновленном документе, то они сохраняются и размечаются аналогично старой разметке. Если в обновленном документе некоторые требования, которые были в старом, исчезли, то их location''ы удаляются. Процесс обновления документа иллюстрируется окном с прогресс-баром (сколько из размеченных требований обновляемого документа проанализировано) и завершается возникновением окна, в котором указывается количество найденных и перенесенных в новый документ location''ов.
77 1 Viktoria Kopach
Обновить документ самим собой нельзя. В окне выбора обновляющего документа при выборе самого себя кнопка OK становится неактивной.
78
79 4 Viktoria Kopach
*HTML Headers Document Processor*
80 5 Viktoria Kopach
При выборе в контекстном меню документа пункта HTML Headers Document Processor должно появиться окно с прогресс-баром, показывающее степень выполнения процесса. По завершении должно появиться окно, сообщающее об успешности выполнения и количестве созданных требований (если ни одного, то 0).
81 4 Viktoria Kopach
82 1 Viktoria Kopach
h3. Действия с папками документов:
83
84
*Контекстное меню папок Documents* (по клику правой кнопки) содержит пункты:
85
* [[DocumentImport|Import Document]] - импортирование документа
86 49 Viktoria Kopach
* Create Folder - создается папка внутри текущей папки.
87
* Remove Folder - удаляется папка (отсутствует для самой папки Documents).
88 10 Viktoria Kopach
89
Пункты Create Folder и Remove Folder сгруппированы в контекстном меню вместе.
90
91
*Create Folder*
92 49 Viktoria Kopach
При создании новой папки открывается окно с полем для ввода имени новой папки и кнопками OK и Cancel.  При  нажатии OK папка с заданным именем создается. При нажатии Cancel окно создания папки просто закрывается, никаких изменений не происходит. Если папка с введенным именем уже существует на том же уровне иерархии, в окне создания папки появляется предупреждение об этом и кнопка OK становится неактивной. Все процедуры происходят внутри папки, на которой вызывается контекстное меню.
93 10 Viktoria Kopach
94
*Remove Folder*
95 49 Viktoria Kopach
Появляется окно для подтверждения удаления папки и всех вложенных в нее папок и документов. Окно содержит кнопки OK и Cancel. 
96 32 Viktoria Kopach
* Для пустой папки: 
97
** При нажатии Cancel окошко просто закрывается, папка не удаляется, никаких изменений не происходит. 
98 33 Viktoria Kopach
** При нажатии OK папка удаляется. 
99 49 Viktoria Kopach
* Для не пустой папки:
100
** В случае Cancel окошко закрывается, ни документы, ни папка не удалены. 
101 33 Viktoria Kopach
** В случае OK: 
102
*** Если ни в одном документе в этой папке или ее подпапках нет ни одного размеченного location''а, то вся папка с документами удаляется.
103
*** Если размеченные location''ы есть, при нажатии ОК это окошко закрывается, но открывается другое окно с предупреждением о наличии размеченных требований в документах папки и двумя кнопками ОК и Cancel. 
104
**** При нажатии Cancel окно закрывается и ничего не происходит. 
105 34 Viktoria Kopach
**** При нажатии ОК вся папка удаляется.
106 33 Viktoria Kopach
107 49 Viktoria Kopach
Location''ы, которые были в удаленных документах, удаляются из базы данных и из требований, в которых они находились. Сами требования не удаляются.
108 36 Alexey Khoroshilov
После удаления папки активным элементом в Requality Explorer становится родительский элемент удаленной папки.
109
110 5 Viktoria Kopach
h2. Requirements
111 6 Viktoria Kopach
112 45 Viktoria Kopach
При *двойном клике* на требовании:
113 1 Viktoria Kopach
# требование становится выделенным;
114
# если для документа первого location требования Document markup editor ещё не открыт, он открывается;
115
# вкладка с указанным Document markup editor становится видимой;
116
# в Outline view первый location требования становится выделенным (следующие два пункта выполняются при любом изменении выделения в Outline view);
117
# документ в указанном Document markup editor перематывается так, чтобы вверху видимой области редактора оказался текст первого location требования;
118
# текст этого location специально подсвечивается;
119 45 Viktoria Kopach
# если для выделенного требования есть pinned Properties view, вкладка с ним становится видимой. Иначе видимой становится вкладка с одним из unpinned Properties view, если такого нет, оно открывается.
120 1 Viktoria Kopach
# подробности выделенного требования отображаются во всех pinned Properties view для него и во всех unpinned Properties View;
121
122
При *выборе требования (одинарный клик, переключение стрелочками)*:
123
# требование становится выделенным.
124
# подробности выделенного требования отображаются во всех pinned Properties view для него и во всех unpinned Properties View;
125
126 8 Viktoria Kopach
*Контекстное меню требований* (по клику правой кнопки) содержит пункты:
127 11 Viktoria Kopach
* Create Requirement - добавление требования.
128
* Remove Requirement - удаление требования
129
* Generate Report... - генерация отчета.
130
131
Create Requirement и Remove Requirement в контекстном меню находятся в одной группе рядом.
132
133
*Create Requirement*
134
Активно для всех требований, включая узел Requirements.
135
Создается требование внутри того требования, на котором открывалось контекстное меню. Имя задается автоматически. Имя - это число: если на этом уровне иерархии других требований нет - это 01, если требования уже есть, то это последний номер (максимальный) + 1. У только что созданного требования нет location''ов.
136
137
*Remove Requirement*
138 35 Viktoria Kopach
Удаление выделенного требования. Неактивно для корневого узла Requirements (этот узел удалить нельзя). Возникает окно для подтверждения удаления, содержащее кнопки OK и Cancel. При нажатии Cancel окно подтверждения просто закрывается, требование не удаляется, никаких изменений не происходит. При нажатии OK  требование удаляется. Все location''ы, входящие только в него, удаляются, их разметка удаляется.
139 36 Alexey Khoroshilov
140
После удаления требования активным элементом в Requality Explorer становится родительский элемент удаленного требования.
141 11 Viktoria Kopach
142
*Generate Report...*
143 14 Viktoria Kopach
Генерация отчета. Появляется окно для настройки отчета. Оно содержит три поля (к двум из которых прилагаются кнопки Browse...):
144 13 Viktoria Kopach
* *Root requirement* -  поле, в котором указывается узел, который будет корневым в отчете (в отчет попадет только этот узел и его "потомки"). По умолчанию указывается тот узел, на котором было открыто контекстное меню. Поле не редактируемое. Его содержимое можно менять только с помощью кнопки *Browse...*, которая расположена рядом. При нажатии этой кнопки открывается окно выбора требования, стандартное для Requality. Оно содержит все дерево требований текущего проекта. Окно выбора требования содержит кнопки create new, Cancel и OK. create new  и OK сначала неактивны, активируются после выбора одного из требований или основной папки проекта. Кнопка create new позволяет создать новое требование, открывает окно для задания его идентификатора. По кнопке Cancel окно выбора требования закрывается, в окне настроек отчета изменений не происходит. По кнопке OK окно выбора требования закрывается, в окне настроек отчета в поле Root requirement устанавливается выбранный узел.
145
* *Template* - поле-выпадающий список, не редактируется. В нем можно выбрать тип шаблона для отчета.
146
* *Save to*: - редактируемое поля для указания пути, по которому создается отчет. Путь можно ввести от руки или выбрать с помощью кнопки *Browse...* рядом с этим полем. По этой кнопке открывается стандартное окно обзора папок.
147 12 Viktoria Kopach
148 13 Viktoria Kopach
Кроме того в окне настройки отчета есть кнопки *OK* и *Cancel*. При нажатии Cancel окно настройки отчета закрывается, отчет не генерируется. При нажатии OK окно настройки отчета закрывается, по указанному пути генерируется отчет, в который включены только выбранный корневой узел и его потомки.