<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
  <head>
    <META http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>XEP-0331: Data Forms - Color Field Types</title>
    <link rel="stylesheet" type="text/css" href="xmpp.css">
    <link href="prettify.css" type="text/css" rel="stylesheet">
    <link rel="shortcut icon" type="image/x-icon" href="favicon.ico"><script type="text/javascript" src="prettify.js"></script><meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=2.0">
    <meta name="DC.Title" content="Data Forms - Color Field Types">
    <meta name="DC.Creator" content="Peter Waher">
    <meta name="DC.Description" content="This specification defines how to publish fields in data forms that take color values. Color values are best edited using a color picker dialog, rather than manual input.">
    <meta name="DC.Publisher" content="XMPP Standards Foundation">
    <meta name="DC.Contributor" content="XMPP Extensions Editor">
    <meta name="DC.Date" content="2013-12-04">
    <meta name="DC.Type" content="XMPP Extension Protocol">
    <meta name="DC.Format" content="XHTML">
    <meta name="DC.Identifier" content="XEP-0331">
    <meta name="DC.Language" content="en">
    <meta name="DC.Rights" content="This XMPP Extension Protocol is copyright © 1999 - 2013 by the XMPP Standards Foundation (XSF).">
  </head>
  <body onload="prettyPrint()">
    <h1>XEP-0331: Data Forms - Color Field Types</h1>
    <table>
      <tr valign="top">
        <td><strong>Abstract:</strong></td>
        <td>This specification defines how to publish fields in data forms that take color values. Color values are best edited using a color picker dialog, rather than manual input.</td>
      </tr>
      <tr valign="top">
        <td><strong>Author:</strong></td>
        <td>Peter Waher</td>
      </tr>
      <tr valign="top">
        <td><strong>Copyright:</strong></td>
        <td>© 1999 - 2013 XMPP Standards Foundation. <a href="#appendix-legal">SEE LEGAL NOTICES</a>.</td>
      </tr>
      <tr valign="top">
        <td><strong>Status:</strong></td>
        <td>Experimental</td>
      </tr>
      <tr valign="top">
        <td><strong>Type:</strong></td>
        <td>Standards Track</td>
      </tr>
      <tr valign="top">
        <td><strong>Version:</strong></td>
        <td>0.2</td>
      </tr>
      <tr valign="top">
        <td><strong>Last Updated:</strong></td>
        <td>2013-12-04</td>
      </tr>
    </table>
    <hr>
    <p style="color:red">WARNING: This Standards-Track document is Experimental. Publication as an XMPP Extension Protocol does not imply approval of this proposal by the XMPP Standards Foundation. Implementation of the protocol described herein is encouraged in exploratory implementations, but production systems are advised to carefully consider whether it is appropriate to deploy implementations of this protocol before it advances to a status of Draft.</p>
    <hr>
    <h2>Table of Contents</h2>
    <div class="indent">
      <p><br>1.  <a href="#intro">Introduction</a><br>2.  <a href="#sect-ID0E5F">Publishing a Color Field in a Data Form</a><br>3.  <a href="#sect-ID0EFH">Publishing a Color Field with Alpha channel in a Data Form</a><br>4.  <a href="#registrar">XMPP Registrar Considerations</a><br>   
      4.1.  <a href="#sect-ID0ERAAC">Color datatype prefix: xdc</a><br>   
      4.2.  <a href="#sect-ID0EBBAC">Color datatype</a><br>   
      4.3.  <a href="#sect-ID0ERBAC">ColorAlpha datatype</a><br>5.  <a href="#schema">XML Schema</a><br>6.  <a href="#ack">Acknowledgements</a></p>
      <p><a href="#appendices">Appendices</a><br>    <a href="#appendix-docinfo">A: Document Information</a><br>    <a href="#appendix-authorinfo">B: Author Information</a><br>    <a href="#appendix-legal">C: Legal Notices</a><br>    <a href="#appendix-xmpp">D: Relation to XMPP</a><br>    <a href="#appendix-discuss">E: Discussion Venue</a><br>    <a href="#appendix-conformance">F: Requirements Conformance</a><br>    <a href="#appendix-notes">G: Notes</a><br>    <a href="#appendix-revs">H: Revision History</a></p>
    </div>
    <hr>
    <h2>1.
       <a name="intro">Introduction</a></h2>
        <p class="" style="">
            Some applications require configuration of color values. Examples can be what colors to use for different situations in control applications.
            There's up to this point no good way to publish color values in a <span class="ref" style=""><a href="http://xmpp.org/extensions/xep-0004.html">Data Forms</a></span>  [<a href="#nt-ID0EZE">1</a>].
        </p>
        <p class="" style="">
            Some applications provide parameters of type list-single enabling the user to choose a color from a list of colors. This only allows the user
            to select from a small amount of colors, and doesn't provide any visual feedback of the actual color chosen.
        </p>
                <p class="" style="">
                        Editing color values as color components or encoded strings is both impractical and unintuitive.
                </p>
                <p class="" style="">
                        This document proposes a method to publish color field parameters in a way that allows clients to show a color picker dialog for the parameter 
                        instead of forcing the user to enter an encoded color value. For clients not supporting this extensions, the color value will still be editable 
                        as an encoded color string.
                </p>
        <p class="" style="">
            This extension also relies on <span class="ref" style=""><a href="http://xmpp.org/extensions/xep-0122.html">Data Forms Validation</a></span>  [<a href="#nt-ID0EWF">2</a>] as a fallback mechanism so clients not recognizing the color data types can handle them as
                        strings with a regular expressions validating user input.
        </p>
    <h2>2.
       <a name="sect-ID0E5F">Publishing a Color Field in a Data Form</a></h2>
        <p class="" style="">
            The following example shows how to publish a Color Field parameter in a Data Form:
        </p>
        <p class="caption"><a name="example-1"></a>Example 1. Publishing a Color Field in a Data Form</p>
    <div class="indent">
      <pre class="prettyprint">
            
    <field var='color' type='text-single' label='Color:'>
        <desc>Choose a color.</desc>
        <xdv:validate xmlns:xdv='http://jabber.org/protocol/xdata-validate'
                      xmlns:xdc='urn:xmpp:xdata:color'
                      datatype='xdc:Color'>
            <xdv:regex>^[0-9a-fA-F]{6}$</xdv:regex>
        </xdv:validate>
        <value>9400D3</value>
    </field>
        </pre>
    </div>
        <p class="" style="">
            The color value is represented by a string consisting of six case-insensitive hexadecimal digits. The first two represent the red component, 
            the next two the green component and the last two the blue component.
        </p>
        <p class="" style="">
            If the client does not support XEP-0122 (Data Form Validation), it will interpret the field as a normal <span class="strong">text-single</span> field. It is
            up to the server to validate user input. But the user can still enter a color.
        </p>
        <p class="" style="">
            A client that supports XEP-0122 (Data Form Validation), but not this extension, will not understand the data type <span class="strong">xdc:Color</span>.
            It will thus default to a normal string (xs:string). However, the client still supports the <span class="strong">regex</span> validation rule,
            making sure the client only allows user input that forms valid color values.
        </p>
        <p class="" style="">
            A client supporting this specification will recognize the <span class="strong">xdc:Color</span> data type, and choose to show a color picker dialog instead
            of a string input field. In this case, the regular expression in the validation statement will not be used, as the string is not edited
            directly by the user. However, it is still available implicitly in the xdc:Color data type.
        </p>
    <h2>3.
       <a name="sect-ID0EFH">Publishing a Color Field with Alpha channel in a Data Form</a></h2>
                <p class="" style="">
                        The following example shows how to publish a Color Field parameter including an Alpha channel in a Data Form:
                </p>
                <p class="caption"><a name="example-2"></a>Example 2. Publishing a Color Field in a Data Form</p>
    <div class="indent">
      <pre class="prettyprint">
                        
    <field var='color' type='text-single' label='Color:'>
        <desc>Choose a color.</desc>
        <xdv:validate xmlns:xdv='http://jabber.org/protocol/xdata-validate'
                      xmlns:xdc='urn:xmpp:xdata:color'
                      datatype='xdc:ColorAlpha'>
            <xdv:regex>^[0-9a-fA-F]{8}$</xdv:regex>
        </xdv:validate>
        <value>9400D3C0</value>
    </field>
                </pre>
    </div>
                <p class="" style="">
                        The color value is represented by a string consisting of eight case-insensitive hexadecimal digits. The first two represent the red component,
                        the next two the green component and the last two the blue component. The last two represents the alpha channel, where 00 means completely
                        transparent and FF means completely opaque.
                </p>
                <p class="" style="">
                        As with the xdc:Color type defined above, if the client does not support XEP-0122 (Data Form Validation), it will interpret the field as a 
                        normal <span class="strong">text-single</span> field. It is up to the server to validate user input. But the user can still enter a color.
                </p>
                <p class="" style="">
                        A client that supports XEP-0122 (Data Form Validation), but not this extension, will not understand the data type <span class="strong">xdc:ColorAlpha</span>.
                        It will thus default to a normal string (xs:string). However, the client still supports the <span class="strong">regex</span> validation rule,
                        making sure the client only allows user input that forms valid color values.
                </p>
                <p class="" style="">
                        A client supporting this specification will recognize the <span class="strong">xdc:ColorAlpha</span> data type, and choose to show a color picker dialog instead
                        of a string input field. In this case, the regular expression in the validation statement will not be used, as the string is not edited
                        directly by the user. However, it is still available implicitly in the xdc:ColorAlpha data type.
                </p>
        <h2>4.
       <a name="registrar">XMPP Registrar Considerations</a></h2>
                <div class="indent">
      <h3>4.1 <a name="sect-ID0ERAAC">Color datatype prefix: xdc</a></h3>
                        <p class="" style="">
                                As defined in <a href="http://xmpp.org/extensions/xep-0122.html#registar-reg-prefixes">XEP-0122 §7.2.1</a>, following is the submission
                                to the XMPP Registrar of a new datatype prefix for use in data forms:
                        </p>
                        <p class="caption">Color datatype prefix: xdc</p>
      <div class="indent">
        <pre class="prettyprint">
                                
    <datatype-prefix>
        <prefix>xdc</prefix>
        <desc>defines the Color data type</desc>
        <doc>http://xmpp.org/extensions/xep-0331.html</doc>
    </datatype-prefix>
                        </pre>
      </div>
                </div>
                <div class="indent">
      <h3>4.2 <a name="sect-ID0EBBAC">Color datatype</a></h3>
                        <p class="" style="">
                                As defined in <a href="http://xmpp.org/extensions/xep-0122.html#registar-reg-datatypes">XEP-0122 §7.2.2</a>, following is the submission
                                to the XMPP Registrar of a new datatype representing color values for use in data forms:
                        </p>
                        <p class="caption">Color datatype</p>
      <div class="indent">
        <pre class="prettyprint">
                                
    <datatype>
        <name>xdc:Color</name>
        <desc>a color value represented as an RGB value, expressed using 6 hexadecimal digits, with each pair of 
        the hexadecimal digits representing the values of the Red, Green and Blue channel, respectively</desc>
        <methods>basic regex</methods>
        <min>N/A</min>
        <max>N/A</max>
    </datatype>
                        </pre>
      </div>
                </div>
                <div class="indent">
      <h3>4.3 <a name="sect-ID0ERBAC">ColorAlpha datatype</a></h3>
                        <p class="" style="">
                                As defined in <a href="http://xmpp.org/extensions/xep-0122.html#registar-reg-datatypes">XEP-0122 §7.2.2</a>, following is the submission
                                to the XMPP Registrar of a new datatype representing color values with alpha channel for use in data forms:
                        </p>
                        <p class="caption">ColorAlpha datatype</p>
      <div class="indent">
        <pre class="prettyprint">
                                
    <datatype>
        <name>xdc:ColorAlpha</name>
        <desc>a color value represented as an RGBA value, expressed using 8 hexadecimal digits, with each pair of 
        the hexadecimal digits representing the values of the Red, Green, Blue and Alpha channel, respectively</desc>
        <methods>basic regex</methods>
        <min>N/A</min>
        <max>N/A</max>
    </datatype>
                        </pre>
      </div>
                </div>
        <h2>5.
       <a name="schema">XML Schema</a></h2>
        <p class="caption">
    </p>
    <div class="indent">
      <pre class="prettyprint">
            
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='urn:xmpp:xdata:color'
    xmlns='urn:xmpp:xdata:color'
    elementFormDefault='qualified'>
 
    <xs:simpleType name='Color'>
        <xs:restriction base='xs:string'>
            <xs:pattern value='^[0-9a-fA-F]{6}$'/>
        </xs:restriction>
    </xs:simpleType>
 
    <xs:simpleType name='ColorAlpha'>
        <xs:restriction base='xs:string'>
            <xs:pattern value='^[0-9a-fA-F]{8}$'/>
        </xs:restriction>
    </xs:simpleType>
 
</xs:schema>
        </pre>
    </div>
    <h2>6.
       <a name="ack">Acknowledgements</a></h2>
                <p class="" style="">Thanks to Karin Forsell for all valuable feedback.</p>
        <hr><a name="appendices"></a><h2>Appendices</h2>
    <hr><a name="appendix-docinfo"></a><h3>Appendix A: Document Information</h3>
    <p class="indent">
            Series: <a href="http://xmpp.org/extensions/">XEP</a><br>
            Number: 0331<br>
            Publisher: <a href="/xsf/">XMPP Standards Foundation</a><br>
            Status: 
            <a href="http://xmpp.org/extensions/xep-0001.html#states-Experimental">Experimental</a><br>
            Type:
            <a href="http://xmpp.org/extensions/xep-0001.html#types-Standards Track">Standards Track</a><br>
            Version: 0.2<br>
            Last Updated: 2013-12-04<br>
                Approving Body: <a href="http://xmpp.org/council/">XMPP Council</a><br>Dependencies: XMPP Core, XEP-0001, XEP-0004, XEP-0030, XEP-0122<br>
                Supersedes: None<br>
                Superseded By: None<br>
            Short Name: color-parameter<br>
              Source Control: 
                <a class="standardsButton" href="http://gitorious.org/xmpp/xmpp/blobs/master/extensions/xep-0331.xml">HTML</a><br>
            This document in other formats: 
                <a class="standardsButton" href="http://xmpp.org/extensions/xep-0331.xml">XML</a> 
                <a class="standardsButton" href="http://xmpp.org/extensions/xep-0331.pdf">PDF</a></p>
    <hr><a name="appendix-authorinfo"></a><h3>Appendix B: Author Information</h3>
    <div class="indent">
      <h3>Peter Waher</h3>
      <p class="indent">
        Email:
        <a href="mailto:peter.waher@clayster.com">peter.waher@clayster.com</a><br>
        JabberID: 
        <a href="xmpp:peter.waher@jabber.org">peter.waher@jabber.org</a><br>
        URI: 
        <a href="http://www.linkedin.com/in/peterwaher">http://www.linkedin.com/in/peterwaher</a><br></p>
    </div>
    <hr><a name="appendix-legal"></a><h3>Appendix C: Legal Notices</h3>
    <div class="indent">
      <h4>Copyright</h4>This XMPP Extension Protocol is copyright © 1999 - 2013 by the <a href="http://xmpp.org/">XMPP Standards Foundation</a> (XSF).<h4>Permissions</h4>Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.<h4>Disclaimer of Warranty</h4><span style="font-weight: bold">## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##</span><h4>Limitation of Liability</h4>In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.<h4>IPR Conformance</h4>This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <<a href="http://xmpp.org/about-xmpp/xsf/xsf-ipr-policy/">http://xmpp.org/about-xmpp/xsf/xsf-ipr-policy/</a>> or obtained by writing to XMPP Standards Foundation, 1899 Wynkoop Street, Suite 600, Denver, CO 80202 USA).</div>
    <hr><a name="appendix-xmpp"></a><h3>Appendix D: Relation to XMPP</h3>
    <p class="indent">The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.</p>
    <hr><a name="appendix-discuss"></a><h3>Appendix E: Discussion Venue</h3>
    <p class="indent">The primary venue for discussion of XMPP Extension Protocols is the <<a href="http://mail.jabber.org/mailman/listinfo/standards">standards@xmpp.org</a>> discussion list.</p>
    <p class="indent">Discussion on other xmpp.org discussion lists might also be appropriate; see <<a href="http://xmpp.org/about/discuss.shtml">http://xmpp.org/about/discuss.shtml</a>> for a complete list.</p>
    <p class="indent">Errata can be sent to <<a href="mailto:editor@xmpp.org">editor@xmpp.org</a>>.</p>
    <hr><a name="appendix-conformance"></a><h3>Appendix F: Requirements Conformance</h3>
    <p class="indent">The following requirements keywords as used in this document are to be interpreted as described in <a href="http://www.ietf.org/rfc/rfc2119.txt">RFC 2119</a>: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".</p>
    <hr><a name="appendix-notes"></a><h3>Appendix G: Notes</h3>
    <div class="indent">
      <p><a name="nt-ID0EZE">1</a>. XEP-0004: Data Forms <<a href="http://xmpp.org/extensions/xep-0004.html">http://xmpp.org/extensions/xep-0004.html</a>>.</p>
      <p><a name="nt-ID0EWF">2</a>. XEP-0122: Data Forms Validation <<a href="http://xmpp.org/extensions/xep-0122.html">http://xmpp.org/extensions/xep-0122.html</a>>.</p>
    </div>
    <hr><a name="appendix-revs"></a><h3>Appendix H: Revision History</h3>
    <p>Note: Older versions of this specification might be available at <a href="http://xmpp.org/extensions/attic/">http://xmpp.org/extensions/attic/</a></p>
    <div class="indent">
      <h4>Version 0.2 (2013-12-04)</h4>
      <div class="indent">
                                <p class="" style="">Namespace changed to urn:xmpp:xdata:color.</p>
                         (pw)
    </div>
      <h4>Version 0.1 (2013-06-26)</h4>
      <div class="indent">
                                <p class="" style="">Initial published version approved by the XMPP Council.</p>
                         (psa)
    </div>
      <h4>Version 0.0.2 (2013-06-11)</h4>
      <div class="indent">
                                <p class="" style="">Added the ColorAlpha data type.</p>
                         (pw)
    </div>
      <h4>Version 0.0.1 (2013-05-27)</h4>
      <div class="indent">
                <p class="" style="">First draft.</p>
             (pw)
    </div>
    </div>
    <hr>
    <p>END</p>
  </body>
</html>