File: adjust-uc_doc.rst

package info (click to toggle)
python-docutils 0.22%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 11,448 kB
  • sloc: python: 53,302; lisp: 14,475; xml: 1,807; javascript: 1,032; makefile: 102; sh: 96
file content (204 lines) | stat: -rw-r--r-- 12,311 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
Use cases section header adjustment
===================================

Conditions
----------

* **Pr**\e\ **f**\erences
  * **N**\o preferences
  * **P**\references exist

* **Sel**\ection
  * **N**\o adornment around point
  * **E**\xisting adornment around point
  * **R**\egion

* **Pr**\e\ **v**\ious header
  * **N**\o previous header
  * **D**\isadvised previous header (i.e. not in preferences)
  * **P**\references contain previous header

* Current header in existing **hie**\rarchy
  * **N**\o hierarchy beyond current header
  * **M**\ultiple occurrence in the middle of existing hierarchy
  * **B**\reaking single entry in the middle of existing hierarchy
  * **L**\ast in existing hierarchy for given direction
  * **O**\nce in existing hierarchy at beginning or end of hierarchy

* **Cur**\rent header in preferences
  * **D**\isadvised (i.e. not in preferences)
  * **S**\uccessor exists in preferences
  * **L**\ast in preferences

* **Dir**\ection
  * **D**\ownward
  * **U**\pward

* **Res**\ult
  * **N**\o next
  * **E**\rror
  * **P**\references give next including rotation
  * **H**\ierarchy gives next including rotation
  * **T**\op of hierarchy
  * **L**\ast of hierarchy

* **Rem**\mark

Use cases
---------

+---+---+---+-----+---+---+-+------+-------------------------------------------+
|Prf|Sel|Prv|Hie  |Cur|Dir|#|Res   |Rem                                        |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|NP |NER|NDP|NMBLO|DSL|DU |#|NEPHTL|                                           |
+===+===+===+=====+===+===+-+======+===========================================+
|N> |?  |<ND|?    |<D |?  | |<NEHTL|[No preferences]                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |N> |<N>|<N   |<! |?  | |E     |Nothing there at all                       |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |N> |<N>|<!   |<! |?  | |T     |At top use top                             |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |N> |<D>|<!   |<! |?  | |H     |New section header in existing hierarchy   |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |E  |<N>|<N   |<D |?  | |E     |One and only header                        |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |<E |<N>|<M   |<D |?  | |H     |Top header matching medium level - continue|
|   |   |   |     |   |   | |      |reorganisation by a step                   |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |<E |<N>|<L   |<D |?  | |H     |Top header matching extreme level -        |
|   |   |   |     |   |   | |      |continue reorganisation by a rotation      |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |<E |<N>|<O   |<D |D  | |T     |Top header with exclusive level downwards -|
|   |   |   |     |   |   | |      |align to top of remaining hierarchy        |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |<E |<N>|<O   |<D |U  | |L     |Top header with exclusive level upwards -  |
|   |   |   |     |   |   | |      |align to last of remaining hierarchy       |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |<E |<D |<M   |<D |?  | |H     |Standard step                              |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |<E |<D |<B   |<D |?  | |H     |Align breaking header                      |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |<E |<D |<L   |<D |?  | |H     |Step or rotate                             |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |<E |<D |<O   |<D |?  | |H     |Step or rotate                             |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|###|###|###|#####|###|###|#|######|###########################################|
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |N> |<N>|N>   |<! |?  | |P     |Only preferences exist                     |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |N> |N> |<!   |<! |D  | |T     |At top downwards use top of hierarchy      |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |N> |N> |<!   |<! |U  | |P     |At top upwards use top of preferences      |
|   |   |   |     |   |   | |      |adding a title                             |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<M   |D  |?  | |H     |Prefer hierarchy over preferences          |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<M   |S  |?  | |H     |Prefer hierarchy over preferences          |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<M   |L  |?  | |H     |Prefer hierarchy over preferences          |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<B   |D  |?  | |H     |Prefer hierarchy over preferences          |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<B   |S  |?  | |H     |Prefer hierarchy over preferences          |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<B   |L  |?  | |H     |Prefer hierarchy over preferences          |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<L   |D  |D  | |H     |Wrap to top level                          |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<L   |D  |U  | |P     |Use first from preferences                 |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<L   |S  |D  | |P     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<L   |S  |U  | |P     |Prefer preferences                         |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<L   |L  |?  | |H     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<O   |D  |?  | |H     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<O   |S  |?  | |H     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |D> |<O   |L  |?  | |H     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |P> |<M   |D  |?  | |H     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |P> |<M   |S  |?  | |H     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |P> |<M   |L  |?  | |H     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |P> |<B   |D  |?  | |H     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |P> |<B   |S  |?  | |H     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |P> |<B   |L  |?  | |H     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |P> |<L   |D  |?  | |P     |Prefer preferences                         |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |P> |<L   |S  |?  | |P     |Prefer preferences                         |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |P> |<L   |L  |?  | |P     |Prefer preferences                         |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |P> |<O   |D  |?  | |H     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |P> |<O   |S  |?  | |H     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|P  |<E |P> |<O   |L  |?  | |H     |Prefer hierarchy                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|   |   |   |     |   |   | |      |                                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|   |   |   |     |   |   | |      |                                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|   |   |   |     |   |   | |      |                                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|   |   |   |     |   |   | |      |[CONSTRAINTS]                              |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |?  |<ND|?    |<D |?  | |<NEHTL|Without preferences no header may relate to|
|   |   |   |     |   |   | |      |them                                       |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|?  |N> |?  |<N!  |<! |?  | |      |Without a selection the current header may |
|   |   |   |     |   |   | |      |not relate to anything                     |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|?  |?  |N> |<NMLO|?  |?  | |      |Without a previous header only certain     |
|   |   |   |     |   |   | |      |relations to hierarchy are possible        |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|?  |?  |D> |<MBLO|?  |?  | |      |With a disadvised previous header only     |
|   |   |   |     |   |   | |      |certain relations to hierarchy are possible|
|   |   |   |     |   |   | |      |for current header                         |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|?  |?  |<N |N>   |?  |?  | |<NPE  |Without hierarchy there can be no previous |
|   |   |   |     |   |   | |      |header and result may not come from        |
|   |   |   |     |   |   | |      |hierarchy                                  |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|?  |<E |   |MBLO>|   |   | |      |If the header has a relation than it must  |
|   |   |   |     |   |   | |      |exist                                      |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|   |   |   |     |   |   | |      |REGION                                     |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|N> |R  |<ND|     |<D |   | |      |                                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+
|   |   |   |     |   |   | |      |                                           |
+---+---+---+-----+---+---+-+------+-------------------------------------------+

* For each line in the table there should be an ert test named
  `rst-adjust-section-prf-_-sel-_-prv-_-hie-_-cur-_-dir-_` where the
  ``_`` stand for the respective cell entries

* In addition each operation should be reversible by using the
  opposite direction

  * Unless the information before reversion is lost by the first
    operation

Legend
------

* "X>" means "if X"

* "<XY" means "X or Y follow from an if"

* "-" means "irrelevant"

* "!" means "does not apply"

* "?" means "any"

* "[X]" means "header for situation group X"