查看源代码

[[Category:XMPP扩展]]
[[Category:翻译中]]

'''本文的英文原文来自[http://www.xmpp.org/extensions/xep-0143.html XEP-0143]

'''XEP-0143: XMPP扩展协议作者指南'''

{|
!摘要:
|本文对XMPP扩展协议的作者提供帮助信息.
|-
!作者:
|Peter Saint-Andre
|-
!版权:
|© 1999 - 2013 XMPP标准化基金会(XSF). 参见[[XEP-0143#附录C:法律通告|法律通告]].
|-
!状态:
|活跃
|-
!类型:
|程序
|-
!版本:
|1.1
|-
!最后更新日期:
|2011-07-08
|}

-----
注意: 这个程序文档定义了一个已经被XMPP委员会和/或XSF董事会批准的XMPP标准基金会(XSF)的流程或活动. XSF目前正是遵循这里定义的流程或活动并且将继续这么做，直到本文档被取消或废除.
-----

==简介==

[http://xmpp.org/xsf/ XMPP标准基金会(XSF)] [[XEP-0143#附录G:备注|1]] 收到大量的提案为[http://tools.ietf.org/html/rfc6120 XMPP Core] [[XEP-0143#附录G:备注|2]]中定义的核心XMPP协议定义扩展. 然而, 作者们并不总是清楚怎样最佳地结构化一个提案以让它能作为一个XMPP扩展(XEP)被接受并从而进一步通过XSF的标准流程. 所以, 本文提供指南来帮助作者写出更好的XMPP扩展协议定义.

这些指南假定读者们对[http://xmpp.org/extensions/xep-0001.html XMPP扩展协议] [[XEP-0143#附录G:备注|3]]所定义的XEP系列文档和XSF处理它们的流程很熟悉, .

==提交提案之前==

强烈鼓励一个可能的作者在提交一个提案成为一个XEP之前完成一些研究. 特别是, 该作者应该做以下几件事:

:* 查看XMPP RFCs和实验性的, 活跃的, 草案, 和最终XEPs以决定是否真的为了填补现有的XMPP技术和协议的空白而需要该建议的协议扩展.
:* 查看被拒绝的和被延期的XEPs, 以及那些永远不会被接受的提案(见 <http://xmpp.org/extensions/inbox/>)来决定是否过去已经有类似的扩展提案但是没有被[http://xmpp.org/council/ XMPP理事会] [[XEP-0143#附录G:备注|4]] 批准.
:* 查看其他标准开发组织开发的协议, 例如[http://www.ietf.org/ 互联网工程工作组(IETF)] [[XEP-0143#附录G:备注|5]]和[http://www.w3.org/ 万维网联盟(W3C)] [[XEP-0143#附录G:备注|6]], 来决定是否它们比在一个新的XMPP扩展里更合适.
:* 查看[http://mail.jabber.org/mailman/listinfo/standards/ Standards SIG] [[XEP-0143#附录G:备注|7]]中的讨论以决定是否过去已经讨论过或目前正在讨论类似的功能.

在完成这些研究之后, 潜在的作者可以断定是否需要新的协议扩展. 如果需要, 强烈建议该作者做以下事情:

# 查看 '''XEP-0001''' 和 [[XEP-0134|XMPP设计准则]] [[XEP-0143#附录G:备注|8]].
# 理解[http://xmpp.org/extensions/xep-0143.html#submit 提交过程].
# 熟悉XEP的XML格式.
# 然后只写一个提案包含所有适当的[http://xmpp.org/extensions/xep-0143.html#sections XEP章节].
# 查看内容并确保它遵循[http://xmpp.org/extensions/xep-0143.html#styleguide XEP Styleguide].

==提交提案==

提交一个提案成为XEP的过程很简单:

# 联系[http://xmpp.org/about-xmpp/xsf/xsf-people/#editor XMPP Extensions Editor] [[XEP-0143#附录G:备注|9]] 让他知道等待你的提案.
# 遵循本文描述的指南写下你的提案.
# 确保你在提交你的提案之前阅读, 理解, 并同意[http://xmpp.org/about-xmpp/xsf/xsf-ipr-policy/ XSF IPR Policy] [[XEP-0143#附录G:备注|10]].
# 把你的XML文件(或一个指向该文件的URL)发给XMPP扩展编辑.

==维护XEP==

如果你的提案被接受成为一个XEP, 你可能需要定期更新这个协议以整合反馈以及实现和部署的经验. XMPP扩展编辑将分配一个号码给你的文档并添加到源文件控制中.

XMPP扩展编辑比较喜欢你按以下步骤工作:

# 遵循<http://xmpp.org/about-xmpp/xsf/xsf-source-control/> 的指引从XSF的git仓库检出一份拷贝
# 对文档做出你期望的修改, 包括一个如下所属的新 <revision/> 元素.
# 使用命令 '''git format-patch HEAD^'''生成一个补丁
# 使用命令 '''git send-email --to=editor@xmpp.org NAMEOF.patch'''发送该补丁

XMPP扩展编辑将应用你的补丁并发布一个你的XEP的更新版本.

注意: 如'''XEP-0001'''解释的一样, 实验状态的XEPs的更新版本的发布不需要XMPP理事会的批准. 无论如何, 活跃,草案,或最终状态的XEPs的更新版本必须由XMPP理事会批准以确保对于已批准的协议的正确的变更控制.

==XEP的XML格式==

XEP的XML格式实质上类似于XHTML的精简集. 这是有意的: 这使XEPs作者更易使用. 实际上, 如果你使用模版文件以及和它相关的XSLT样式表, 你应该能够在大多数现代浏览器中查看你的提案(见下文). 以下章节解释了如何开始XEP的写作并描述了用于XEPs的XML格式(正式的描述参见 xep.xsd 或 xep.dtd 文件).

===和XEP文件一起工作===
===文件元数据===
===文件内容===