| 1 |
<pre>Internet Engineering Task Force (IETF) R. Sparks |
| 2 |
Request for Comments: 7842 Oracle |
| 3 |
Category: Informational April 2016 |
| 4 |
ISSN: 2070-1721 |
| 5 |
|
| 6 |
|
| 7 |
<span class="h1">Requirements for Improvements to the IETF Email List Archiving,</span> |
| 8 |
<span class="h1">Web-Based Browsing, and Search Tool</span> |
| 9 |
|
| 10 |
Abstract |
| 11 |
|
| 12 |
The web-based IETF email archive search tool based on the |
| 13 |
requirements captured in <a href="./rfc6778">RFC 6778</a> was deployed in January 2014. This |
| 14 |
memo captures the requirements for a set of improvements that have |
| 15 |
been identified during its initial years of community use. |
| 16 |
|
| 17 |
Status of This Memo |
| 18 |
|
| 19 |
This document is not an Internet Standards Track specification; it is |
| 20 |
published for informational purposes. |
| 21 |
|
| 22 |
This document is a product of the Internet Engineering Task Force |
| 23 |
(IETF). It represents the consensus of the IETF community. It has |
| 24 |
received public review and has been approved for publication by the |
| 25 |
Internet Engineering Steering Group (IESG). Not all documents |
| 26 |
approved by the IESG are a candidate for any level of Internet |
| 27 |
Standard; see <a href="./rfc5741#section-2">Section 2 of RFC 5741</a>. |
| 28 |
|
| 29 |
Information about the current status of this document, any errata, |
| 30 |
and how to provide feedback on it may be obtained at |
| 31 |
<a href="http://www.rfc-editor.org/info/rfc7842">http://www.rfc-editor.org/info/rfc7842</a>. |
| 32 |
|
| 33 |
Copyright Notice |
| 34 |
|
| 35 |
Copyright (c) 2016 IETF Trust and the persons identified as the |
| 36 |
document authors. All rights reserved. |
| 37 |
|
| 38 |
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal |
| 39 |
Provisions Relating to IETF Documents |
| 40 |
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of |
| 41 |
publication of this document. Please review these documents |
| 42 |
carefully, as they describe your rights and restrictions with respect |
| 43 |
to this document. Code Components extracted from this document must |
| 44 |
include Simplified BSD License text as described in Section 4.e of |
| 45 |
the Trust Legal Provisions and are provided without warranty as |
| 46 |
described in the Simplified BSD License. |
| 47 |
|
| 48 |
|
| 49 |
|
| 50 |
|
| 51 |
|
| 52 |
<span class="grey">Sparks Informational [Page 1]</span></pre> |
| 53 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span> |
| 54 |
<span class="grey"><a href="./rfc7842">RFC 7842</a> List Archiving and Search Requirements April 2016</span> |
| 55 |
|
| 56 |
|
| 57 |
Table of Contents |
| 58 |
|
| 59 |
<a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a> |
| 60 |
<a href="#section-2">2</a>. List Search and Archive Tool Improvement Requirements . . . . <a href="#page-2">2</a> |
| 61 |
<a href="#section-2.1">2.1</a>. Viewing by Thread . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a> |
| 62 |
<a href="#section-2.2">2.2</a>. Navigation from the Message List View . . . . . . . . . . <a href="#page-3">3</a> |
| 63 |
<a href="#section-2.3">2.3</a>. Navigation from a Single Message . . . . . . . . . . . . <a href="#page-3">3</a> |
| 64 |
<a href="#section-2.4">2.4</a>. Message List UI . . . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a> |
| 65 |
<a href="#section-2.5">2.5</a>. Improve Support for Mobile Devices . . . . . . . . . . . <a href="#page-5">5</a> |
| 66 |
<a href="#section-2.6">2.6</a>. Improve Use of Display Space . . . . . . . . . . . . . . <a href="#page-5">5</a> |
| 67 |
<a href="#section-2.7">2.7</a>. Use without JavaScript . . . . . . . . . . . . . . . . . <a href="#page-5">5</a> |
| 68 |
<a href="#section-2.8">2.8</a>. Administration . . . . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a> |
| 69 |
<a href="#section-3">3</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a> |
| 70 |
<a href="#section-4">4</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a> |
| 71 |
<a href="#section-4.1">4.1</a>. Normative References . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a> |
| 72 |
<a href="#section-4.2">4.2</a>. Informative References . . . . . . . . . . . . . . . . . <a href="#page-6">6</a> |
| 73 |
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a> |
| 74 |
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-7">7</a> |
| 75 |
|
| 76 |
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span> |
| 77 |
|
| 78 |
The IETF email archive search tool, as specified in [<a href="./rfc6778" title=""Requirements for Archiving IETF Email Lists and for Providing Web-Based Browsing and Searching"">RFC6778</a>]) and |
| 79 |
available at [<a href="#ref-mailarch">mailarch</a>], has been in use for nearly two years. |
| 80 |
During that time, there have been repeated requests for several |
| 81 |
improvements. This memo captures the requirements for a concerted |
| 82 |
development effort to provide those improvements. |
| 83 |
|
| 84 |
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. List Search and Archive Tool Improvement Requirements</span> |
| 85 |
|
| 86 |
<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. Viewing by Thread</span> |
| 87 |
|
| 88 |
Currently, when the "Group by Thread" button is selected, the |
| 89 |
resulting list of messages is flat. It is very hard to tell where a |
| 90 |
thread starts and stops. This flat view interacts badly with sorting |
| 91 |
(triggered by clicking on the column headers), leading to results |
| 92 |
that are confusing and sometimes incorrect. |
| 93 |
|
| 94 |
This effort will: |
| 95 |
|
| 96 |
o Modify the message list display, when grouped by thread, to show |
| 97 |
each thread hierarchically. |
| 98 |
|
| 99 |
o Modify the sort performed by the clicking on the column headers to |
| 100 |
sort the overall list first by the parameters in the first message |
| 101 |
in the thread, and then sort within the thread (ensuring the |
| 102 |
thread grouping doesn't change based on these sorts). When |
| 103 |
viewing threads sorted this way, the hierarchy will be flattened, |
| 104 |
but the thread boundaries will remain visibly distinct. |
| 105 |
|
| 106 |
|
| 107 |
|
| 108 |
<span class="grey">Sparks Informational [Page 2]</span></pre> |
| 109 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span> |
| 110 |
<span class="grey"><a href="./rfc7842">RFC 7842</a> List Archiving and Search Requirements April 2016</span> |
| 111 |
|
| 112 |
|
| 113 |
<span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>. Navigation from the Message List View</span> |
| 114 |
|
| 115 |
This effort will add navigation to the message list view, whether |
| 116 |
viewing flat search results or viewing by thread, making it simple |
| 117 |
to: |
| 118 |
|
| 119 |
o Navigate to the previous/next message by date in the set of listed |
| 120 |
messages. |
| 121 |
|
| 122 |
o Navigate to the previous/next message in a thread, to the first |
| 123 |
message in a thread, and to the previous/next thread displayed. |
| 124 |
|
| 125 |
o Navigate to any References or Replies (displayed as Follow-Ups in |
| 126 |
MHonArc) for the currently selected message. These are derived |
| 127 |
from the References header field in the displayed message, and the |
| 128 |
In-Reply-To header field or the last value in the References |
| 129 |
header field of all other messages in the archive). |
| 130 |
|
| 131 |
The UI will make it possible to hide these navigation elements. |
| 132 |
|
| 133 |
<span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a>. Navigation from a Single Message</span> |
| 134 |
|
| 135 |
Currently, when viewing a single message, the only option for |
| 136 |
navigating to related messages is to return to the message list view |
| 137 |
(either by date or by thread). This is implemented with a new search |
| 138 |
based only on the details present in the message itself. No |
| 139 |
information about any search that led to the message is retained. |
| 140 |
|
| 141 |
This effort will: |
| 142 |
|
| 143 |
o Add navigation to the single message view, enabling transition to |
| 144 |
previous/next in list and previous/next in thread. |
| 145 |
|
| 146 |
o Add navigation enabling transition to previous/next in search, if |
| 147 |
the message page being displayed was arrived at by navigating from |
| 148 |
the message list view of a search result. |
| 149 |
|
| 150 |
o Add navigation to any References or Replies (displayed as Follow- |
| 151 |
Ups in MHonArc). These are derived from the References header |
| 152 |
field in the displayed message, and the In-Reply-To header field |
| 153 |
or the last value in the References header field of all other |
| 154 |
messages in the archive. |
| 155 |
|
| 156 |
o Make it possible to hide these navigation elements. |
| 157 |
|
| 158 |
|
| 159 |
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 |
<span class="grey">Sparks Informational [Page 3]</span></pre> |
| 165 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span> |
| 166 |
<span class="grey"><a href="./rfc7842">RFC 7842</a> List Archiving and Search Requirements April 2016</span> |
| 167 |
|
| 168 |
|
| 169 |
<span class="h3"><a class="selflink" id="section-2.4" href="#section-2.4">2.4</a>. Message List UI</span> |
| 170 |
|
| 171 |
It is not sufficiently obvious that the message list panel can be |
| 172 |
resized. The current handle is not visually distinct enough to |
| 173 |
signal the capability to the user, leaving many users believing they |
| 174 |
are restricted to the very short default list, even when viewing on |
| 175 |
large monitors. |
| 176 |
|
| 177 |
Additionally, there is a flaw in the code that fetches additional |
| 178 |
messages when scrolling to the bottom of what's currently displayed. |
| 179 |
If the message window is large enough that the default number of |
| 180 |
results does not fill it, no scrollbar appears, and scrolling to the |
| 181 |
bottom does not fetch additional results. |
| 182 |
|
| 183 |
The filter by list and filter by from sections to the left of the |
| 184 |
message list have no values in many circumstances, but it is not |
| 185 |
obvious why they are missing. One notable condition is when the |
| 186 |
search result is very large -- computing the values to put in these |
| 187 |
filters becomes prohibitively expensive. Without foreknowledge of |
| 188 |
the decisions captured in the code, the behavior seems arbitrary and |
| 189 |
unintuitive. |
| 190 |
|
| 191 |
The current view truncates fields, leaving trailing ellipses, when it |
| 192 |
doesn't need to. This leaves space underutilized on large displays |
| 193 |
and may make selection (particularly of long email addresses in the |
| 194 |
filters) much more difficult than it should be. On small displays, |
| 195 |
the column of filters dominates the display, leaving only a small |
| 196 |
amount of space for the actual message content. |
| 197 |
|
| 198 |
The current view requires the user to select each message in the |
| 199 |
message list to get the URI to that message. This makes it difficult |
| 200 |
to open several messages in different windows, or to build a list of |
| 201 |
URIs for use in a message or other applications. It is also not |
| 202 |
obvious that double-clicking a row in the list will open the message |
| 203 |
in a separate window. |
| 204 |
|
| 205 |
This effort will: |
| 206 |
|
| 207 |
o Make the ability to resize the panels on the message list display |
| 208 |
easier to find. |
| 209 |
|
| 210 |
o Account for the size of the message list panel when choosing how |
| 211 |
many messages to fetch, filling the panel whenever there are |
| 212 |
enough results to do so. |
| 213 |
|
| 214 |
o Provide a message explaining any condition leading to filter |
| 215 |
values not being populated (such as "Refine search to enable |
| 216 |
'From' filtering"). |
| 217 |
|
| 218 |
|
| 219 |
|
| 220 |
<span class="grey">Sparks Informational [Page 4]</span></pre> |
| 221 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span> |
| 222 |
<span class="grey"><a href="./rfc7842">RFC 7842</a> List Archiving and Search Requirements April 2016</span> |
| 223 |
|
| 224 |
|
| 225 |
o Allow subjects to fill the column on large displays. Show fully |
| 226 |
expanded list and email addresses in the pop-ups for the filters. |
| 227 |
|
| 228 |
o Provide a link on each row of the list to the URL for that row's |
| 229 |
message. |
| 230 |
|
| 231 |
o Add an export type that produces a file containing a list of URIs |
| 232 |
to each message in the list. |
| 233 |
|
| 234 |
o Add a hint to the UI that double-clicking on a row in the list |
| 235 |
will open a single-message view of the associated message in a |
| 236 |
separate view. |
| 237 |
|
| 238 |
<span class="h3"><a class="selflink" id="section-2.5" href="#section-2.5">2.5</a>. Improve Support for Mobile Devices</span> |
| 239 |
|
| 240 |
The current view becomes difficult to use on small displays, |
| 241 |
particularly phone displays in portrait mode. This effort will: |
| 242 |
|
| 243 |
o Add a responsive interface, presenting a useful interface on both |
| 244 |
small and large displays. |
| 245 |
|
| 246 |
<span class="h3"><a class="selflink" id="section-2.6" href="#section-2.6">2.6</a>. Improve Use of Display Space</span> |
| 247 |
|
| 248 |
The current view underutilizes the available display space. This |
| 249 |
effort will: |
| 250 |
|
| 251 |
o Make the message content the primary point of each view. |
| 252 |
|
| 253 |
o Reduce the unused space on the display. |
| 254 |
|
| 255 |
o Remove the filter column responsively when the display width is |
| 256 |
small. |
| 257 |
|
| 258 |
<span class="h3"><a class="selflink" id="section-2.7" href="#section-2.7">2.7</a>. Use without JavaScript</span> |
| 259 |
|
| 260 |
The current web-based archive search tool requires JavaScript to |
| 261 |
function. This effort will extend the tool to allow users that have |
| 262 |
disabled JavaScript in their browser to retrieve and navigate through |
| 263 |
search results using the message list and single message views. |
| 264 |
|
| 265 |
This effort will not attempt to preserve all of the functionality |
| 266 |
provided with JavaScript enabled. In particular, when running with |
| 267 |
JavaScript disabled, these features will not be available: |
| 268 |
|
| 269 |
o Resizing of the message list panels. |
| 270 |
|
| 271 |
o Dynamically filtering by time, list, or from. (The filter column |
| 272 |
will not appear). |
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
<span class="grey">Sparks Informational [Page 5]</span></pre> |
| 277 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span> |
| 278 |
<span class="grey"><a href="./rfc7842">RFC 7842</a> List Archiving and Search Requirements April 2016</span> |
| 279 |
|
| 280 |
|
| 281 |
<span class="h3"><a class="selflink" id="section-2.8" href="#section-2.8">2.8</a>. Administration</span> |
| 282 |
|
| 283 |
This project will: |
| 284 |
|
| 285 |
o Add a link from the message view to the admin page for the message |
| 286 |
when logged in as an administrator. |
| 287 |
|
| 288 |
o Add correction of the appropriate thread indices to the handling |
| 289 |
of administrative imports of messages. |
| 290 |
|
| 291 |
o Implement a redirection handler mapping legacy archive URLs to the |
| 292 |
appropriate mailarch page. |
| 293 |
|
| 294 |
o Make the underlying template consistent across all views presented |
| 295 |
by the tool. In particular, ensure that the correct logo as |
| 296 |
designated by the IETF Administrative Oversight Committee (IAOC) |
| 297 |
appears consistently on all views. |
| 298 |
|
| 299 |
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Security Considerations</span> |
| 300 |
|
| 301 |
The requirements for improvement to the mailarch tool captured in |
| 302 |
this document do not introduce any exceptional security |
| 303 |
considerations. They add additional navigation points, and the |
| 304 |
implementers should consider the impact of rapid navigation using |
| 305 |
these new mechanisms (see the security considerations of [<a href="./rfc6778" title=""Requirements for Archiving IETF Email Lists and for Providing Web-Based Browsing and Searching"">RFC6778</a>]). |
| 306 |
|
| 307 |
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. References</span> |
| 308 |
|
| 309 |
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Normative References</span> |
| 310 |
|
| 311 |
[<a id="ref-RFC6778">RFC6778</a>] Sparks, R., "Requirements for Archiving IETF Email Lists |
| 312 |
and for Providing Web-Based Browsing and Searching", |
| 313 |
<a href="./rfc6778">RFC 6778</a>, DOI 10.17487/RFC6778, October 2012, |
| 314 |
<<a href="http://www.rfc-editor.org/info/rfc6778">http://www.rfc-editor.org/info/rfc6778</a>>. |
| 315 |
|
| 316 |
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. Informative References</span> |
| 317 |
|
| 318 |
[<a id="ref-mailarch">mailarch</a>] |
| 319 |
IETF, "Mail Archive", <<a href="https://mailarchive.ietf.org">https://mailarchive.ietf.org</a>>. |
| 320 |
|
| 321 |
Acknowledgments |
| 322 |
|
| 323 |
The following people have provided particularly useful input for this |
| 324 |
document: Lou Berger, Chris Bowers, Brian Carpenter, Russ Housley, |
| 325 |
Pete Resnick, and Dale Worley. |
| 326 |
|
| 327 |
|
| 328 |
|
| 329 |
|
| 330 |
|
| 331 |
|
| 332 |
<span class="grey">Sparks Informational [Page 6]</span></pre> |
| 333 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span> |
| 334 |
<span class="grey"><a href="./rfc7842">RFC 7842</a> List Archiving and Search Requirements April 2016</span> |
| 335 |
|
| 336 |
|
| 337 |
Author's Address |
| 338 |
|
| 339 |
Robert Sparks |
| 340 |
Oracle |
| 341 |
7460 Warren Parkway |
| 342 |
Suite 300 |
| 343 |
Frisco, Texas 75034 |
| 344 |
United States |
| 345 |
|
| 346 |
Email: [email protected] |
| 347 |
|
| 348 |
|
| 349 |
|
| 350 |
|
| 351 |
|
| 352 |
|
| 353 |
|
| 354 |
|
| 355 |
|
| 356 |
|
| 357 |
|
| 358 |
|
| 359 |
|
| 360 |
|
| 361 |
|
| 362 |
|
| 363 |
|
| 364 |
|
| 365 |
|
| 366 |
|
| 367 |
|
| 368 |
|
| 369 |
|
| 370 |
|
| 371 |
|
| 372 |
|
| 373 |
|
| 374 |
|
| 375 |
|
| 376 |
|
| 377 |
|
| 378 |
|
| 379 |
|
| 380 |
|
| 381 |
|
| 382 |
|
| 383 |
|
| 384 |
|
| 385 |
|
| 386 |
|
| 387 |
|
| 388 |
Sparks Informational [Page 7] |
| 389 |
</pre> |