Project

General

Profile

Perspective » History » Version 65

Viktoria Kopach, 03/28/2011 11:45 AM

1 17 Alexey Demakov
h1. Перспектива Requality
2 18 Alexey Demakov
3 17 Alexey Demakov
Перспектива Requality содержит:
4
# Requality Explorer view, в котором отображается дерево проектов и их содержимое (документы, требования и т.п.);
5
# Properties view, в котором отображаются подробности отдельных элементов проекта;
6
# Document Markup editor, в котором осуществляется редактирование и просмотр разметки документа;
7
# Document Markup Outline view, в котором отображается структура разметки документа.
8
9 65 Viktoria Kopach
h2. 1. * [[requality-explorer-view|Requality Explorer view]]
10 6 Viktoria Kopach
11
Requality Explorer содержит все проекты, что и PackageExplorer, но развернуть можно только проекты типа Requality.
12
В Requality-проекте есть две папки: Documents и Requirements (содержащие, соответственно, документы с требованиями и сами требования).
13 48 Viktoria Kopach
14 47 Viktoria Kopach
*Documents*
15
При двойном клике на документ он открывается в редакторе Markup editor.
16 57 Viktoria Kopach
Контекстное меню папок Documents содержит пункты:
17 1 Alexey Demakov
* Import Document - импортирование документа
18 57 Viktoria Kopach
* Create Folder - создается папка внутри текущей папки (отсутствует для самой папки Documents).
19
* Remove Folder - удаляется папка.
20 60 Viktoria Kopach
При импорте документа открывается окно, в котором нужно выбрать импортируемый документ. Так же нужно указать папку, куда этот документ будет импортирован. По умолчанию изначально выделена та папку, на которой кликали, чтобы открыть импортирование документа. В окне импорта есть кнопка для создания новой папки.
21 57 Viktoria Kopach
При удалении пустой папки должно появляться аналогичное окно для подтверждения удаления папки. в случае отрицательного ответа папка не удаляется, в случае положительного - удаляется. При удалении папки, содержащей документы, должно появиться аналогичное окно, но в нем еще должно быть сообщение о том, что папка не пуста и ее удаление повлечет за собой удаление всех вложенных документов. В случае отрицательного ответа ни документы, ни папка не должны быть удалены. В случае положительного - папка с документами удаляется.
22 47 Viktoria Kopach
23
Контекстное меню документов содержит пункты:
24 49 Viktoria Kopach
* Create Folder - создается папка на уровне документа в той же папке.
25
* Remove Document - документ удаляется. Что происходит с location''ами и требованиями, у которых location''ы только в этом документе?
26 47 Viktoria Kopach
* Update Document
27 49 Viktoria Kopach
* HTML Headers Document Processor - создается требование для каждого тега <h#>...</h#>.
28 47 Viktoria Kopach
При выборе в контекстном меню документа пункта HTML Headers Document Processor должно появиться окно с прогресс-баром, показывающее степень выполнения процесса. По завершении должно появиться окно, сообщающее об успешности выполнения и количестве созданных требований (если ни одного, то 0)
29
30
*Requirements*
31 19 Alexey Demakov
При *двойном клике* на требование:
32
# требование становится выделенным;
33
# если для документа первого location требования Document markup editor ещё не открыт, он открывается;
34 23 Alexey Demakov
# вкладка с указанным Document markup editor становится видимой;
35 20 Alexey Demakov
# в Outline view первый location требования становится выделенным (следующие два пункта выполняются при любом изменении выделения в Outline view);
36 19 Alexey Demakov
# документ в указанном Document markup editor перематывается так, чтобы вверху видимой области редактора оказался текст первого location требования;
37 22 Alexey Demakov
# текст этого location специально подсвечивается;
38 23 Alexey Demakov
# если для выделенного требования есть pinned Properties view, вкладка с ним становится видимой. Иначе видимой становится вкладка с одними из unpinned Properties view, если такого нет, оно открывается.
39 1 Alexey Demakov
# подробности выделенного требования отображаются во всех pinned Properties view для него и во всех unpinned Properties View;
40
41
При *выборе требования (одинарный клик, переключение стрелочками)*:
42
# требование становится выделенным.
43
# подробности выделенного требования отображаются во всех pinned Properties view для него и во всех unpinned Properties View;
44 49 Viktoria Kopach
45
Контекстное меню требований содержит пункты:
46
* Add Requirement...
47
* Remove Requirement
48
* Generate Report
49 22 Alexey Demakov
50 41 Viktoria Kopach
h2. 2. Properties view (Редактор требований).
51 1 Alexey Demakov
52 2 Viktoria Kopach
Properties view содержит вкладки:
53
* Main
54
** Id
55
** Name
56
** Attributes
57 3 Viktoria Kopach
* Advanced
58
** Predicate (возможно стоит его перенести на вкладку Main? Или он может быть слишком большой?)
59
** Base requirement
60
* Descriptions
61 1 Alexey Demakov
** Alternative description
62 50 Viktoria Kopach
** список location''ов, отсортированный по документам.
63 26 Alexey Demakov
* Source
64
** json
65 1 Alexey Demakov
66 44 Viktoria Kopach
*Меню (view menu)*
67
* *Во view menu пункт Pin to Selection*.
68
* При выборе этого пункта меню нажимается кнопка Pin (это второй способ ее нажатия). Кнопка Pin выглядит нажатой. Этот пункт меню выделяется как нажатый. При повторном нажатии Pin отжимается и выделение пункта меню снимается. Кнопка Pin отжата. Все происходящие изменения такие же, как при нажатии кнопки Pin.
69 1 Alexey Demakov
70 44 Viktoria Kopach
* *Во view menu пункт New Properties View*
71
* При выборе этого пункта открывается новая закладка с редактором того же требования и не нажатой кнопкой Pin. (Что будет, если в редакторе внести изменения, не сохранить и выбрать это меню?)
72 43 Viktoria Kopach
73 44 Viktoria Kopach
* *Кнопка «Канцелярская кнопка» (Pin) для закрепления Properties view* 
74 45 Viktoria Kopach
* Если кнопка Pin выглядит нажатой, то это Properties View отображает детали фиксированного требования, которое было выделенным в момент нажатия кнопки. Если кнопка Pin выглядит отжатой, то в этом Properties View отображаются детали выделенного требования. При изменении выделения меняется и отображаемое требование.
75
76
*Вкладка Main*
77 1 Alexey Demakov
Поля Id и Name имеют возможность редактирования. Изначально в поле Name стоит такое же значение, как и Id.
78 50 Viktoria Kopach
В таблице Attributes при двойном клике на атрибут можно его редактировать. Около таблицы есть кнопки Add (позволяет добавить новый атрибут) и Remove (позволяет удалить атрибут, который в данный момент выделен). Remove активна только тогда, когда выделен один из атрибутов в таблице. 
79 44 Viktoria Kopach
80 1 Alexey Demakov
*Вкладка Advanced*
81 50 Viktoria Kopach
Поле предиката может редактироваться.
82
Около таблицы Base Requirements есть кнопки Add (позволяет добавить новое базовое требование) и Remove (позволяет удалить базовое требование, которое в данный момент выделено). Remove активна только тогда, когда выделено одно из требований в таблице.
83 61 Viktoria Kopach
При нажатии (дабл-клик) на базовое требование происходит переход к редактору базового требования (Если окно редактора не закреплено - редактор базового требования открывается в нем. Если закреплено, но есть другое открытое незакрепленное окно редактора - то в этом окне. Иначе - нигде.) Так же нужно перелистывать документ в Markup''е на нужное location. И, соответственно, переключать Outline.
84 55 Viktoria Kopach
В качестве базового требования для текущего требования нельзя добавить само текущее требование. В реализации нужно либо исключить возможность выбрать само текущее требование (например, не отображать его в списке требований), либо при попытке нажать ОК в выборе требования выводить сообщение о недопустимости такого действия.
85 4 Viktoria Kopach
86 44 Viktoria Kopach
-*Выбор другого документа*
87
Если на вкладке Documents нажать документ, который еще не был открыт, то он откроется на первом указанном в редакторе требования location, находящемся в этом документе (location пролистывается в верх видимой области и выделяется цветом). Этот же location выделяется в Outline.-
88 1 Alexey Demakov
89 46 Viktoria Kopach
*Вкладка Description*
90 38 Viktoria Kopach
В Description находится список имен всех location''ов этого требования (из всех документов), отсортированный по документам (???). Имена location''ов выглядят так же, как и в outline: 
91
user-visible-name(req) - это
92
* name, если name не пустое 
93 1 Alexey Demakov
* user-visible-name(req.parent).id, иначе.
94 38 Viktoria Kopach
95 64 Alexey Khoroshilov
При дабл-клике на имя location''а документ пролистывается на этот location. Если документ с этим location''ом не был еще открыт, то он открывается. Редактор документа становится видимым. Происходят все соответствующие переключения в Outline и Requality Explorer.
96 38 Viktoria Kopach
97 27 Alexey Demakov
*Кнопка переключения между location''ами*
98 1 Alexey Demakov
В редакторе требования есть кнопка для переключения на следующий и предыдущий location. Порядок location''ов соответствует их порядку в редакторе требования. При переключении на другой location этот location выделяется в Outline и редакторе документа (пролистывается в верх видимой области и выделяется цветом).
99 51 Viktoria Kopach
100 54 Viktoria Kopach
*Внесение изменений на вкладке, кнопка Save*
101
Кнопка Save есть во вкладках Main, Advanced и Description. Она неактивны изначально. Становится активна при редактировании информации на ее вкладке. При нажатии сохраняет внесенные изменения, после чего становится неактивной (до внесения новых изменений).
102
При внесении изменений на вкладке в ее заголовке появляется значок "*" (звездочка). Исчезает после сохранения изменений. Если в окне Properties на одной из вкладок внести изменения, не сохранить и переключиться на другую вкладку, должно появляться окно с предупреждением о том, что есть несохраненные изменения, и предложением их сохранить.
103 1 Alexey Demakov
104 42 Viktoria Kopach
h2. 3. Document Markup editor (Редактор документа)
105 41 Viktoria Kopach
106 53 Viktoria Kopach
Это окно-браузер с текстом документа. В нем размечаются требования. Редактировать текст нельзя.
107
*Выделение требований из окна Document Markup editor.*
108
Выделить часть текста, в контекстном меню выбрать Add to requirement... Появляется окно Requirement selection со списком уже существующих требований. 
109
+Окно Requirement selection.+
110
Позволяет выбрать существующее требование для добавления в него location''а или создать новое. Имеет кнопки create new, OK и Cancel. Если одно из требований (или папка требований) выбрано, то все три кнопки активны, иначе активна только кнопка Cancel. Новое требование создается внутри выбранного требования.
111
При нажатии create new открывается окно редактора идентификатора, в котором есть строка для ввода идентификатора нового требования и кнопки OK и Cancel (обе активные). После ввода Id и нажатия OK в окне выбора требования в дереве требований появляется новое требование с введенным Id, расположенное внутри требования, которое было выбрано; новое требование теперь выделено. Если Id не было введено (поле осталось пустым), при нажатии OK появляется предупреждение о том, что Id не может быть пустым. Если требование с таким Id уже существует внутри узла выбранного требования, появляется предупреждение о том, что требование с таким Id уже есть.
112
При нажатии OK в окне выбора требования окно закрывается, а location добавляется к выбранному требованию.
113 62 Viktoria Kopach
Если этот location не был ранее выделен, то он маркируется выделением.
114 1 Alexey Demakov
115 62 Viktoria Kopach
*Поиск по документу.*
116 63 Viktoria Kopach
Поиск по документу открывается через контекстное меню Find... и по hot-key CTRL+F. При этом открывается окно поиска. 
117
В окне поиска есть редактируемое поле (выпадащий список), в котором указывается искомый текст. Это поле раскрывается в список предыдущих запросов поиска. Если выделить какой-то кусок текста в документе и вызвать поиск, выделенный текст появится в этом поле. 
118
Окно поиска содержит следующие галочки: учитывать регистр, только слово целиком. 
119
Окно поиска содержит следующие кнопки: искать все, искать далее, искать к началу документа (вверх по документу). Должны быть горячие клавиши для поиска вниз по документу и для поиска к началу документа.
120 62 Viktoria Kopach
121 53 Viktoria Kopach
*В контекстном меню есть пункт Show identifiers.* При выборе этого пункта над всеми location''ами появляются всплывающие подсказки с их Id (или именами?). В контекстном меню этот пункт выделяется галочкой, как выбранный. При снятии галочки всплывающие подсказки исчезают.
122
Если Show identifiers не выбран, то при наведении курсора на требование возникает всплывающая подсказка с его именем.
123
124 1 Alexey Demakov
*В контекстном меню есть пункт Show version.* При его выборе возникает окно с информацией о версии используемого браузера.
125 62 Viktoria Kopach
126
*В контекстном меню есть пункт Find...* При выборе этого меню открывается окно поиска.
127
128 41 Viktoria Kopach
129 42 Viktoria Kopach
h2. 4. Document Markup Outline view
130 36 Viktoria Kopach
131 34 Viktoria Kopach
+Outline - плоский вид+
132 36 Viktoria Kopach
133 34 Viktoria Kopach
В Outline должен быть список location''ов в порядке их присутствия в html документе.
134 1 Alexey Demakov
135 34 Viktoria Kopach
Каждый location отображается следующим образом:
136 40 Viktoria Kopach
# Если location соответствует ноль требований в базе, то отображается текст "orphan location" красным жирным шрифтом.
137
# Если location соответствует одно требование, то user-visible-name(req).
138
# Если location соответствует несколько требований, то user-visible-name(req1),user-visible-name(req2),user-visible-name(req3).
139 1 Alexey Demakov
140
Если в данном документе у одного требования несколько location''ов, то в тексте выше user-visible-name(req) заменяется на user-visible-name(req)#i, где i - порядковый номер location''а среди всех location''ов данного требования в данном документе.
141
142 40 Viktoria Kopach
Определение user-visible-name(req) следующее: 
143
* name, если name не пустое 
144
* user-visible-name(req.parent).id, иначе
145 34 Viktoria Kopach
146
Кроме того, Outline должет быть синхронизирован с Document''ом в том смысле, что
147 40 Viktoria Kopach
# всегда при событии приводящем к промотке документа на определенный location, этот location должен выделяться в Outline.
148
# при выделении location в Outline необходимо проматывать документ к этому location.
149 1 Alexey Demakov
150 36 Viktoria Kopach
-(Зачеркнуто, т.к. неактуально, но может понадобиться потом)-
151 35 Viktoria Kopach
-В outline находится список всех location''ов. Список может быть в двух форматах:-
152
* -список location''ов в порядке их нахождения в документе (в текущем открытом документе или во всех документах?)-
153
* -список location''ов, сгруппированных по требованиям (требования - это узлы, раскрывающиеся в списки location''ов). Внутри группы location''ы упорядочены в порядке нахождения в документе. - надо разбить на два: в одном все location''ы только из текущего документа, в другом - все location''ы, принадлежащие требованиям, которые есть в этом документе (включая location''ы из других документов).-
154 31 Viktoria Kopach
155 30 Viktoria Kopach
При выборе одного из location''ов:
156
# документ пролистывается так, чтобы это location оказалось вверху видимой области документа
157 37 Viktoria Kopach
# текст location''а в документе размечается выделением. 
158 30 Viktoria Kopach
# если документ был закрыт, то он сначала открывается. - ?
159 15 Viktoria Kopach
При этом 
160 32 Viktoria Kopach
# если выбирается location, принадлежащий документу, редактор которого открыт, но неактивен, этот редактор становится активен и выполняются все вышеперечисленные пункты.
161 15 Viktoria Kopach
# -если выбирается location, принадлежащий документу, редактор которого не открыт, этот редактор открывается и выполняются все вышеперечисленные пункты.-
162 16 Viktoria Kopach
# если выбирается location, принадлежащий другому требованию (которое сейчас не выбрано), это требование выделяется в Requality Explorer''е и открывается в Properties view и выполняются все вышеперечисленные пункты.