Commit 87ef2f39 authored by Luigi Toscano's avatar Luigi Toscano

Use the correct entites (&HTML;, &XML;)

The old entites (&html;, &xml;) were defined locally but
they duplicated the official ones, so they have been removed
in a previous commit.
parent 6a5512a0
......@@ -11,19 +11,19 @@ Beginning with &kopete; 1.0, &kopete; ships with a plugin called Pipes. Pipes al
<listitem><para>The body of the message, in plain &ascii; text</para></listitem>
</varlistentry>
<varlistentry>
<term>&html; text body</term>
<listitem><para>The body of the message, in &html;, as it would be if your chat peer had sent HTML to you, which will be rendered in the chat window</para></listitem>
<term>&HTML; text body</term>
<listitem><para>The body of the message, in &HTML;, as it would be if your chat peer had sent HTML to you, which will be rendered in the chat window</para></listitem>
</varlistentry>
<varlistentry>
<term>&xml; full message</term>
<listitem><para>An &xml; document that describes all the characteristics of the message, including the &html; body.</para></listitem>
<term>&XML; full message</term>
<listitem><para>An &XML; document that describes all the characteristics of the message, including the &HTML; body.</para></listitem>
</varlistentry>
</variablelist>
This document describes the specifics of the &xml; format, and how to write a program that can handle it.
This document describes the specifics of the &XML; format, and how to write a program that can handle it.
</para>
<sect1 id="xml-output">
<title>&xml; Output</title>
<title>&XML; Output</title>
<para>
Here's an example of what a program will receive in its standard input stream:
<literallayout>
......@@ -60,7 +60,7 @@ Here's an example of what a program will receive in its standard input stream:
&lt;/message>
</literallayout>
This &xml; is loosely based on the XSD used for chatstyles found at <ulink url="http://kopete.kde.org/files/kopetemessage.xsd">the Kopete website</ulink>. This code represents one message.
This &XML; is loosely based on the XSD used for chatstyles found at <ulink url="http://kopete.kde.org/files/kopetemessage.xsd">the Kopete website</ulink>. This code represents one message.
There are a few things to note:
<itemizedlist>
<listitem><para>The "timestamp" attribute in the "message" element is in ISO 8601 standard format.</para></listitem>
......@@ -71,15 +71,15 @@ There are a few things to note:
</orderedlist>
</para></listitem>
<listitem><para>The "color" and "bgcolor" attributes in the "body" element are empty strings if they are not set in Kopete. They are in web color format.</para></listitem>
<listitem><para>The content inside the "body" element has "&lt;" escaped, so it is not confused with the actual &xml; structure. Obviously, to correctly interpret the body as HTML, one would have to convert the "&amp;lt;"s to "&lt;"s.</para></listitem>
<listitem><para>The content inside the "body" element has "&lt;" escaped, so it is not confused with the actual &XML; structure. Obviously, to correctly interpret the body as HTML, one would have to convert the "&amp;lt;"s to "&lt;"s.</para></listitem>
</itemizedlist>
</para>
</sect1>
<sect1 id="xml-input">
<title>&xml; Input</title>
<title>&XML; Input</title>
<para>
Your program will receive &xml; in its standard input stream, it will have the opportunity to modify it, and then it must hand it back to &kopete; by way of its standard output stream. If your program modifies the following elements, the internal knowledge that &kopete; has of the message will be modified to reflect your changes.
Your program will receive &XML; in its standard input stream, it will have the opportunity to modify it, and then it must hand it back to &kopete; by way of its standard output stream. If your program modifies the following elements, the internal knowledge that &kopete; has of the message will be modified to reflect your changes.
<itemizedlist>
<listitem><para>"message" attribute "timestamp" but not other time attributes</para></listitem>
<listitem><para>"message" attribute "subject"</para></listitem>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment