XEP-0048
小 (→url元素) |
(→数据格式) |
||
| 第45行： | 第45行： | ||
===conference元素=== | ===conference元素=== | ||
| − | + | 常见的用例是多用户聊天室的书签. 一个房间使用 <conference/> 子元素来标记书签. 语法如下. | |
| − | + | :'''表1: conference元素的语法''' | |
| − | + | :{|border="1" cellspacing="0" | |
!元素或属性 !!定义 !!数据类型 !!必要性 | !元素或属性 !!定义 !!数据类型 !!必要性 | ||
|- | |- | ||
| 第63行： | 第63行： | ||
|} | |} | ||
| − | + | 注意: datatypes(数据类型) 定义于 [http://www.w3.org/TR/xmlschema-2/ XML Schema Part 2] [[XEP-0048#附录G:备注|3]] . | |
| − | + | '''示例1. 一个conference元素的例子''' | |
<source lang="xml"> | <source lang="xml"> | ||
| 第79行： | 第79行： | ||
:这个书签将显示为 'Council of Oberon' 并且, 如果激活它, 将尝试以昵称 'Puck' 加入会议室 'council@conference.underhill.org' . | :这个书签将显示为 'Council of Oberon' 并且, 如果激活它, 将尝试以昵称 'Puck' 加入会议室 'council@conference.underhill.org' . | ||
| − | :注意: | + | :注意: 一个书签组可以包含不限数量的会议室. |
===url元素=== | ===url元素=== | ||
| 第85行： | 第85行： | ||
<url/>元素设计用于标记web页面, 例如, HTTP 或 HTTPS URLs. 语法如下. | <url/>元素设计用于标记web页面, 例如, HTTP 或 HTTPS URLs. 语法如下. | ||
| − | '''表2: url元素的语法''' | + | :'''表2: url元素的语法''' |
| + | |||
| + | :{|border="1" cellspacing="0" | ||
| + | !属性 !!定义 !!数据类型 !!必要性 | ||
| + | |- | ||
| + | |'name' 属性 ||书签的一个友好名字. ||string ||推荐 | ||
| + | |- | ||
| + | |'url' 属性 ||web页面的HTTP或HTTPS URL. ||anyURI ||必需 | ||
| + | |} | ||
| + | |||
| + | 当用户选择一个URL书签, 该客户端应该启动一个适当的浏览器或直接把URL装载到客户端 (如果那个客户端是一个web客户端或包含web浏览功能). | ||
| + | |||
| + | '''示例2. 一个url元素的例子''' | ||
| + | |||
| + | <source lang="xml"> | ||
| + | <storage xmlns='storage:bookmarks'> | ||
| + | <url name='Complete Works of Shakespeare' | ||
| + | url='http://the-tech.mit.edu/Shakespeare/'/> | ||
| + | </storage> | ||
| + | </source> | ||
| + | |||
| + | 这个书签将在客户端显示为 'Complete Works of Shakespeare' 并且当它被选中的时候会把用户带到 <http://the-tech.mit.edu/Shakespeare/> . | ||
| + | |||
| + | 注意: 一个书签组可以包含任意数量的URLs. | ||
==存储== | ==存储== | ||
2011年11月29日 (二) 06:28的版本
本文的英文原文来自XEP-0048
XEP-0048: 书签
| 摘要: | 本协议定义了一个XML数据格式让XMPP客户端存储多用户聊天室和web页面的书签。聊天室书签功能还包括登录时自动加入房间的功能. |
|---|---|
| 作者: | Rachel Blackman, Peter Millard, Peter Saint-Andre |
| 版权: | © 1999 - 2011 XMPP标准化基金会(XSF). 参见法律通告. |
| 状态: | 草案 |
| 类型: | 标准跟踪 |
| 版本: | 1.1 |
| 最后更新日期: | 2007-11-07 |
注意: 这里定义的协议是XMPP标准化基金会的一个 草案标准 .对本协议的执行是被鼓励的,也适于部署到生产系统,但是在它成为最终标准之前可能还会有一些变动.
目录 |
简介
为了让Jabber客户端易于使用, 需要一个办法把很多服务和资源 (例如会议室和web页面) 的快捷方式存储成为可以在用户的客户端显示的 "书签". 许多Jabber客户端已经同意并实现了一个方法来提供这个服务; 这个非正式的约定在本文中做了记录和扩展. 典型的, 我们引入 <storage/> 元素 (由 'storage:bookmarks' 命名空间限定) 作为一个这类数据的容器. 因为书签数据可能使用任何XML存储机制来存储, 本文推荐了一个特定的用于XMPP的方法.
数据格式
一个由 'storage:bookmarks' 命名空间限定的 storage 元素可以包含一组子元素, 每个子元素代表一个书签显示在客户端上. 目前, 只定义了两个子元素: <conference/> 用于 多用户聊天 室 1 的书签 ， <url/> 用于web页面的书签.
所有子元素允许有一个 'name' 属性, 它是一个显示给客户端的友好的名字. 如果一个元素缺少 'name' 属性, 客户端应该基于可用的其他数据生成一个适当的替代品.
conference元素
常见的用例是多用户聊天室的书签. 一个房间使用 <conference/> 子元素来标记书签. 语法如下.
- 表1: conference元素的语法
元素或属性 定义 数据类型 必要性 'autojoin' 属性 客户端是否应该在登录时自动加入会议室. boolean，缺省为false 2 可选 'jid' 属性 聊天室的JabberID. string 必需 'name' 属性 书签的一个友好名字. string 推荐 <nick/> 元素 用户在这个聊天室中的首选昵称. string 可选 <password/>元素 未加密的字符串，用来加入一个密码保护的房间. 处于安全性的原因, 不推荐使用这个元素. string 不推荐
注意: datatypes(数据类型) 定义于 XML Schema Part 2 3 .
示例1. 一个conference元素的例子
<storage xmlns='storage:bookmarks'> <conference name='Council of Oberon' autojoin='true' jid='council@conference.underhill.org'> <nick>Puck</nick> </conference> </storage>
- 这个书签将显示为 'Council of Oberon' 并且, 如果激活它, 将尝试以昵称 'Puck' 加入会议室 'council@conference.underhill.org' .
- 注意: 一个书签组可以包含不限数量的会议室.
url元素
<url/>元素设计用于标记web页面, 例如, HTTP 或 HTTPS URLs. 语法如下.
- 表2: url元素的语法
属性 定义 数据类型 必要性 'name' 属性 书签的一个友好名字. string 推荐 'url' 属性 web页面的HTTP或HTTPS URL. anyURI 必需
当用户选择一个URL书签, 该客户端应该启动一个适当的浏览器或直接把URL装载到客户端 (如果那个客户端是一个web客户端或包含web浏览功能).
示例2. 一个url元素的例子
<storage xmlns='storage:bookmarks'> <url name='Complete Works of Shakespeare' url='http://the-tech.mit.edu/Shakespeare/'/> </storage>
这个书签将在客户端显示为 'Complete Works of Shakespeare' 并且当它被选中的时候会把用户带到 <http://the-tech.mit.edu/Shakespeare/> .
注意: 一个书签组可以包含任意数量的URLs.
