Internet Engineering Task Force (IETF)                         R. Sparks
Request for Comments: 7842                                        Oracle
Category: Informational                                       April 2016
ISSN: 2070-1721
        
Internet Engineering Task Force (IETF)                         R. Sparks
Request for Comments: 7842                                        Oracle
Category: Informational                                       April 2016
ISSN: 2070-1721
        

Requirements for Improvements to the IETF Email List Archiving, Web-Based Browsing, and Search Tool

改进IETF电子邮件列表归档、基于Web的浏览和搜索工具的要求

Abstract

摘要

The web-based IETF email archive search tool based on the requirements captured in RFC 6778 was deployed in January 2014. This memo captures the requirements for a set of improvements that have been identified during its initial years of community use.

基于网络的IETF电子邮件存档搜索工具基于RFC 6778中捕获的需求,于2014年1月部署。本备忘录捕获了在社区使用的最初几年中确定的一系列改进的要求。

Status of This Memo

关于下段备忘

This document is not an Internet Standards Track specification; it is published for informational purposes.

本文件不是互联网标准跟踪规范;它是为了提供信息而发布的。

This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Not all documents approved by the IESG are a candidate for any level of Internet Standard; see Section 2 of RFC 5741.

本文件是互联网工程任务组(IETF)的产品。它代表了IETF社区的共识。它已经接受了公众审查,并已被互联网工程指导小组(IESG)批准出版。并非IESG批准的所有文件都适用于任何级别的互联网标准;见RFC 5741第2节。

Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at http://www.rfc-editor.org/info/rfc7842.

有关本文件当前状态、任何勘误表以及如何提供反馈的信息,请访问http://www.rfc-editor.org/info/rfc7842.

Copyright Notice

版权公告

Copyright (c) 2016 IETF Trust and the persons identified as the document authors. All rights reserved.

版权所有(c)2016 IETF信托基金和确定为文件作者的人员。版权所有。

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.

本文件受BCP 78和IETF信托有关IETF文件的法律规定的约束(http://trustee.ietf.org/license-info)自本文件出版之日起生效。请仔细阅读这些文件,因为它们描述了您对本文件的权利和限制。从本文件中提取的代码组件必须包括信托法律条款第4.e节中所述的简化BSD许可证文本,并提供简化BSD许可证中所述的无担保。

Table of Contents

目录

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  List Search and Archive Tool Improvement Requirements . . . .   2
     2.1.  Viewing by Thread . . . . . . . . . . . . . . . . . . . .   2
     2.2.  Navigation from the Message List View . . . . . . . . . .   3
     2.3.  Navigation from a Single Message  . . . . . . . . . . . .   3
     2.4.  Message List UI . . . . . . . . . . . . . . . . . . . . .   4
     2.5.  Improve Support for Mobile Devices  . . . . . . . . . . .   5
     2.6.  Improve Use of Display Space  . . . . . . . . . . . . . .   5
     2.7.  Use without JavaScript  . . . . . . . . . . . . . . . . .   5
     2.8.  Administration  . . . . . . . . . . . . . . . . . . . . .   6
   3.  Security Considerations . . . . . . . . . . . . . . . . . . .   6
   4.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   6
     4.1.  Normative References  . . . . . . . . . . . . . . . . . .   6
     4.2.  Informative References  . . . . . . . . . . . . . . . . .   6
   Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . .   6
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   7
        
   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  List Search and Archive Tool Improvement Requirements . . . .   2
     2.1.  Viewing by Thread . . . . . . . . . . . . . . . . . . . .   2
     2.2.  Navigation from the Message List View . . . . . . . . . .   3
     2.3.  Navigation from a Single Message  . . . . . . . . . . . .   3
     2.4.  Message List UI . . . . . . . . . . . . . . . . . . . . .   4
     2.5.  Improve Support for Mobile Devices  . . . . . . . . . . .   5
     2.6.  Improve Use of Display Space  . . . . . . . . . . . . . .   5
     2.7.  Use without JavaScript  . . . . . . . . . . . . . . . . .   5
     2.8.  Administration  . . . . . . . . . . . . . . . . . . . . .   6
   3.  Security Considerations . . . . . . . . . . . . . . . . . . .   6
   4.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   6
     4.1.  Normative References  . . . . . . . . . . . . . . . . . .   6
     4.2.  Informative References  . . . . . . . . . . . . . . . . .   6
   Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . .   6
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   7
        
1. Introduction
1. 介绍

The IETF email archive search tool, as specified in [RFC6778]) and available at [mailarch], has been in use for nearly two years. During that time, there have been repeated requests for several improvements. This memo captures the requirements for a concerted development effort to provide those improvements.

如[RFC6778]所述,IETF电子邮件存档搜索工具已在[mailarch]上使用近两年。在这段时间里,有人一再要求进行一些改进。本备忘录描述了提供这些改进的协调开发工作的要求。

2. List Search and Archive Tool Improvement Requirements
2. 列出搜索和归档工具改进要求
2.1. Viewing by Thread
2.1. 线程查看

Currently, when the "Group by Thread" button is selected, the resulting list of messages is flat. It is very hard to tell where a thread starts and stops. This flat view interacts badly with sorting (triggered by clicking on the column headers), leading to results that are confusing and sometimes incorrect.

当前,当选择“按线程分组”按钮时,生成的消息列表是扁平的。很难判断线程从何处开始和停止。此平面视图与排序交互不好(通过单击列标题触发),导致结果混乱,有时不正确。

This effort will:

这项努力将:

o Modify the message list display, when grouped by thread, to show each thread hierarchically.

o 修改按线程分组时的消息列表显示,以分层显示每个线程。

o Modify the sort performed by the clicking on the column headers to sort the overall list first by the parameters in the first message in the thread, and then sort within the thread (ensuring the thread grouping doesn't change based on these sorts). When viewing threads sorted this way, the hierarchy will be flattened, but the thread boundaries will remain visibly distinct.

o 修改通过单击列标题执行的排序,首先按照线程中第一条消息中的参数对整个列表进行排序,然后在线程内进行排序(确保线程分组不会基于这些排序而更改)。当查看以这种方式排序的线程时,层次结构将变平,但线程边界将保持明显的不同。

2.2. Navigation from the Message List View
2.2. 从消息列表视图进行导航

This effort will add navigation to the message list view, whether viewing flat search results or viewing by thread, making it simple to:

这项工作将向邮件列表视图添加导航,无论是查看平面搜索结果还是按线程查看,都可以简化以下操作:

o Navigate to the previous/next message by date in the set of listed messages.

o 在列出的消息集中按日期导航到上一条/下一条消息。

o Navigate to the previous/next message in a thread, to the first message in a thread, and to the previous/next thread displayed.

o 导航到线程中的上一条/下一条消息、线程中的第一条消息以及显示的上一条/下一条线程。

o Navigate to any References or Replies (displayed as Follow-Ups in MHonArc) for the currently selected message. These are derived from the References header field in the displayed message, and the In-Reply-To header field or the last value in the References header field of all other messages in the archive).

o 导航到当前所选邮件的任何引用或回复(在MHonArc中显示为跟进)。这些值来自所显示邮件中的References标头字段、in Reply To标头字段或存档中所有其他邮件的References标头字段中的最后一个值)。

The UI will make it possible to hide these navigation elements.

UI将使隐藏这些导航元素成为可能。

2.3. Navigation from a Single Message
2.3. 从单个消息导航

Currently, when viewing a single message, the only option for navigating to related messages is to return to the message list view (either by date or by thread). This is implemented with a new search based only on the details present in the message itself. No information about any search that led to the message is retained.

当前,查看单个邮件时,导航到相关邮件的唯一选项是返回邮件列表视图(按日期或按线程)。这是通过仅基于消息本身中存在的详细信息的新搜索来实现的。不会保留有关导致该邮件的任何搜索的信息。

This effort will:

这项努力将:

o Add navigation to the single message view, enabling transition to previous/next in list and previous/next in thread.

o 将导航添加到单个消息视图中,从而启用到列表中的上一个/下一个和线程中的上一个/下一个的转换。

o Add navigation enabling transition to previous/next in search, if the message page being displayed was arrived at by navigating from the message list view of a search result.

o 如果要显示的消息页面是通过从搜索结果的消息列表视图导航到达的,则添加导航以在搜索中转换到上一个/下一个。

o Add navigation to any References or Replies (displayed as Follow-Ups in MHonArc). These are derived from the References header field in the displayed message, and the In-Reply-To header field or the last value in the References header field of all other messages in the archive.

o 添加任何参考或回复的导航(在MHonArc中显示为后续)。这些值来自所显示邮件中的引用标头字段,以及存档中所有其他邮件的回复标头字段或引用标头字段中的最后一个值。

o Make it possible to hide these navigation elements.

o 使隐藏这些导航元素成为可能。

2.4. Message List UI
2.4. 消息列表用户界面

It is not sufficiently obvious that the message list panel can be resized. The current handle is not visually distinct enough to signal the capability to the user, leaving many users believing they are restricted to the very short default list, even when viewing on large monitors.

消息列表面板是否可以调整大小还不够明显。当前的句柄在视觉上不够清晰,无法向用户发送功能信号,这使得许多用户认为,即使在大型监视器上查看时,他们也仅限于非常短的默认列表。

Additionally, there is a flaw in the code that fetches additional messages when scrolling to the bottom of what's currently displayed. If the message window is large enough that the default number of results does not fill it, no scrollbar appears, and scrolling to the bottom does not fetch additional results.

此外,代码中还有一个缺陷,当滚动到当前显示内容的底部时,会获取额外的消息。如果消息窗口足够大,以至于默认的结果数没有填满它,则不会显示滚动条,并且滚动到底部不会获取其他结果。

The filter by list and filter by from sections to the left of the message list have no values in many circumstances, but it is not obvious why they are missing. One notable condition is when the search result is very large -- computing the values to put in these filters becomes prohibitively expensive. Without foreknowledge of the decisions captured in the code, the behavior seems arbitrary and unintuitive.

消息列表左侧的filter by list和filter by from部分在许多情况下都没有值,但不清楚它们丢失的原因。一个值得注意的情况是,当搜索结果非常大时,计算要放入这些过滤器的值会变得非常昂贵。如果事先不知道代码中捕获的决策,该行为似乎是任意和不直观的。

The current view truncates fields, leaving trailing ellipses, when it doesn't need to. This leaves space underutilized on large displays and may make selection (particularly of long email addresses in the filters) much more difficult than it should be. On small displays, the column of filters dominates the display, leaving only a small amount of space for the actual message content.

当前视图在不需要时截断字段,留下尾随椭圆。这使得大屏幕上的空间未得到充分利用,并且可能使选择(尤其是过滤器中的长电子邮件地址)比实际情况更加困难。在小型显示器上,过滤器列占主导地位,只为实际消息内容留下少量空间。

The current view requires the user to select each message in the message list to get the URI to that message. This makes it difficult to open several messages in different windows, or to build a list of URIs for use in a message or other applications. It is also not obvious that double-clicking a row in the list will open the message in a separate window.

当前视图要求用户选择消息列表中的每条消息,以获取该消息的URI。这使得在不同的窗口中打开多条消息,或者构建一个URI列表以便在消息或其他应用程序中使用变得困难。双击列表中的一行将在单独的窗口中打开消息,这一点也不明显。

This effort will:

这项努力将:

o Make the ability to resize the panels on the message list display easier to find.

o 使调整消息列表显示面板大小的功能更容易找到。

o Account for the size of the message list panel when choosing how many messages to fetch, filling the panel whenever there are enough results to do so.

o 在选择要获取多少消息时,考虑消息列表面板的大小,只要有足够的结果,就填充面板。

o Provide a message explaining any condition leading to filter values not being populated (such as "Refine search to enable 'From' filtering").

o 提供一条消息,解释导致未填充筛选值的任何条件(例如“优化搜索以启用“来自”筛选”)。

o Allow subjects to fill the column on large displays. Show fully expanded list and email addresses in the pop-ups for the filters.

o 允许主题在大屏幕上填充列。在过滤器的弹出窗口中显示完全展开的列表和电子邮件地址。

o Provide a link on each row of the list to the URL for that row's message.

o 在列表的每一行上提供指向该行消息URL的链接。

o Add an export type that produces a file containing a list of URIs to each message in the list.

o 向列表中的每条消息添加一个导出类型,该导出类型生成一个包含URI列表的文件。

o Add a hint to the UI that double-clicking on a row in the list will open a single-message view of the associated message in a separate view.

o 向UI添加一个提示,双击列表中的一行将在单独的视图中打开关联消息的单个消息视图。

2.5. Improve Support for Mobile Devices
2.5. 改进对移动设备的支持

The current view becomes difficult to use on small displays, particularly phone displays in portrait mode. This effort will:

当前视图很难在小型显示器上使用,尤其是纵向模式下的手机显示器。这项努力将:

o Add a responsive interface, presenting a useful interface on both small and large displays.

o 添加响应界面,在小型和大型显示器上显示有用的界面。

2.6. Improve Use of Display Space
2.6. 改善展示空间的使用

The current view underutilizes the available display space. This effort will:

当前视图未充分利用可用的显示空间。这项努力将:

o Make the message content the primary point of each view.

o 使消息内容成为每个视图的主要观点。

o Reduce the unused space on the display.

o 减少显示器上未使用的空间。

o Remove the filter column responsively when the display width is small.

o 当显示宽度较小时,应相应地删除筛选列。

2.7. Use without JavaScript
2.7. 不使用JavaScript的情况下使用

The current web-based archive search tool requires JavaScript to function. This effort will extend the tool to allow users that have disabled JavaScript in their browser to retrieve and navigate through search results using the message list and single message views.

当前基于web的归档搜索工具需要JavaScript才能正常工作。这项工作将扩展该工具,允许在浏览器中禁用JavaScript的用户使用消息列表和单个消息视图检索和浏览搜索结果。

This effort will not attempt to preserve all of the functionality provided with JavaScript enabled. In particular, when running with JavaScript disabled, these features will not be available:

这项工作不会试图保留启用JavaScript时提供的所有功能。特别是在禁用JavaScript的情况下运行时,这些功能将不可用:

o Resizing of the message list panels.

o 调整消息列表面板的大小。

o Dynamically filtering by time, list, or from. (The filter column will not appear).

o 按时间、列表或源动态筛选。(过滤器列将不显示)。

2.8. Administration
2.8. 管理

This project will:

该项目将:

o Add a link from the message view to the admin page for the message when logged in as an administrator.

o 以管理员身份登录时,添加从邮件视图到邮件管理页面的链接。

o Add correction of the appropriate thread indices to the handling of administrative imports of messages.

o 将适当线程索引的更正添加到消息管理导入的处理中。

o Implement a redirection handler mapping legacy archive URLs to the appropriate mailarch page.

o 实现重定向处理程序,将旧存档URL映射到相应的mailarch页面。

o Make the underlying template consistent across all views presented by the tool. In particular, ensure that the correct logo as designated by the IETF Administrative Oversight Committee (IAOC) appears consistently on all views.

o 使基础模板在工具显示的所有视图中保持一致。特别是,确保IETF管理监督委员会(IAOC)指定的正确徽标始终出现在所有视图上。

3. Security Considerations
3. 安全考虑

The requirements for improvement to the mailarch tool captured in this document do not introduce any exceptional security considerations. They add additional navigation points, and the implementers should consider the impact of rapid navigation using these new mechanisms (see the security considerations of [RFC6778]).

本文档中对mailarch工具的改进要求并未引入任何特殊的安全注意事项。他们添加额外的导航点,并且实现者应该考虑使用这些新机制的快速导航的影响(参见[RCF678]的安全考虑)。

4. References
4. 工具书类
4.1. Normative References
4.1. 规范性引用文件

[RFC6778] Sparks, R., "Requirements for Archiving IETF Email Lists and for Providing Web-Based Browsing and Searching", RFC 6778, DOI 10.17487/RFC6778, October 2012, <http://www.rfc-editor.org/info/rfc6778>.

[RFC6778]Sparks,R.“存档IETF电子邮件列表和提供基于Web的浏览和搜索的要求”,RFC 6778,DOI 10.17487/RFC6778,2012年10月<http://www.rfc-editor.org/info/rfc6778>.

4.2. Informative References
4.2. 资料性引用

[mailarch] IETF, "Mail Archive", <https://mailarchive.ietf.org>.

[mailarch]IETF,“邮件存档”<https://mailarchive.ietf.org>.

Acknowledgments

致谢

The following people have provided particularly useful input for this document: Lou Berger, Chris Bowers, Brian Carpenter, Russ Housley, Pete Resnick, and Dale Worley.

以下人员为本文提供了特别有用的输入:Lou Berger、Chris Bowers、Brian Carpenter、Russ Housley、Pete Resnick和Dale Worley。

Author's Address

作者地址

Robert Sparks Oracle 7460 Warren Parkway Suite 300 Frisco, Texas 75034 United States

Robert Sparks Oracle 7460 Warren Parkway套房300美国德克萨斯州弗里斯科75034

   Email: rjsparks@nostrum.com
        
   Email: rjsparks@nostrum.com