svn: /pear/peardoc/trunk/ en/package/webservices/services-libravatar/basic.xml en/package/webservices/services-libravatar.xml en/package/webservices-entities.xml entities/global.ent

--69fb5bb6fb01c31ac64dcfdb06c196d1662ed5a7
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit

cweiske                                  Wed, 08 Aug 2012 21:19:58 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=327031

Log:
documentation for services_libravatar

Changed paths:
    A   pear/peardoc/trunk/en/package/webservices/services-libravatar/
    A   pear/peardoc/trunk/en/package/webservices/services-libravatar/basic.xml
    A   pear/peardoc/trunk/en/package/webservices/services-libravatar.xml
    U   pear/peardoc/trunk/en/package/webservices-entities.xml
    U   pear/peardoc/trunk/entities/global.ent

Added: pear/peardoc/trunk/en/package/webservices/services-libravatar/basic.xml
===================================================================
--- pear/peardoc/trunk/en/package/webservices/services-libravatar/basic.xml	                        (rev 0)
+++ pear/peardoc/trunk/en/package/webservices/services-libravatar/basic.xml	2012-08-08 21:19:58 UTC (rev 327031)
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="utf-8"?>
+<section
+ xmlns="http://docbook.org/ns/docbook"
+ xmlns:phd="http://www.php.net/ns/phd"
+ version="lillet"
+ xml:id="package.webservices.services-libravatar.basic"
+>
+ <info>
+  <title>Basic usage</title>
+ </info>
+
+ <para>
+  After including the base
+  <phd:pearapi phd:package="Services_Libravatar" phd:linkend="Services_Libravatar"/>
+  file, create an object of the class.
+  You may set default options for
+  <phd:pearapi phd:package="Services_Libravatar" phd:linkend="Services_Libravatar::setSize">image size</phd:pearapi>,
+  <phd:pearapi phd:package="Services_Libravatar" phd:linkend="Services_Libravatar::setDefault">default url</phd:pearapi>,
+  <phd:pearapi phd:package="Services_Libravatar" phd:linkend="Services_Libravatar::setHttps">HTTPS mode</phd:pearapi>
+  and
+  <phd:pearapi phd:package="Services_Libravatar" phd:linkend="Services_Libravatar::setAlgorithm">hashing algorithm</phd:pearapi>.
+ </para>
+ <para>
+  After you created the <literal>Services_Libravatar</literal> instance, call
+  <phd:pearapi phd:package="Services_Libravatar" phd:linkend="Services_Libravatar::getUrl"/>
+  on it with the email as parameter.
+ </para>
+
+ <example>
+  <info>
+   <title>Creating a libravatar instance</title>
+  </info>
+
+  <programlisting role="php"><![CDATA[
+require_once 'Services/Libravatar.php';
+$sla = new Services_Libravatar();
+$sla->setSize(256)
+    ->setDefault('identicon');
+
+$url = $sla->getUrl('[email protected]');
+]]></programlisting>
+ </example>
+
+ <para>
+  Instead of manually deciding if you need HTTPS or not,
+  <literal>Services_Libravatar</literal> will detect that automatically when
+  calling
+  <phd:pearapi phd:package="Services_Libravatar" phd:linkend="Services_Libravatar::detectHttps">detectHttps()</phd:pearapi>.
+ </para>
+
+ <para>
+  If you temporarily need different options for one image, you may
+  pass them as option array as second parameter to <literal>getUrl()</literal>.
+  They will override the class options that were configured via the
+  <literal>set*()</literal> methods, but only for the current
+  <literal>getUrl()</literal> call:
+ </para>
+
+ <example>
+  <info>
+   <title>Using temporary options</title>
+  </info>
+
+  <programlisting role="php"><![CDATA[
+require_once 'Services/Libravatar.php';
+$sla = new Services_Libravatar();
+$sla->setSize(256)
+    ->setDefault('identicon');
+
+$url1Big   = $sla->getUrl('[email protected]');//size 256
+$url1Small = $sla->getUrl(
+    '[email protected]',
+    array('size' => 32, 'default' => '404')
+);
+
+//size 256 again
+$url2Big = $sla->getUrl('[email protected]');
+]]></programlisting>
+ </example>
+
+</section>
\ No newline at end of file

Added: pear/peardoc/trunk/en/package/webservices/services-libravatar.xml
===================================================================
--- pear/peardoc/trunk/en/package/webservices/services-libravatar.xml	                        (rev 0)
+++ pear/peardoc/trunk/en/package/webservices/services-libravatar.xml	2012-08-08 21:19:58 UTC (rev 327031)
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<book
+ xmlns="http://docbook.org/ns/docbook"
+ xmlns:phd="http://www.php.net/ns/phd"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ version="lillet"
+ xml:id="package.webservices.services-libravatar"
+>
+ <info>
+  <title>Services_Libravatar</title>
+  <abstract>
+   <para>
+    <link xlink:href="&url.pear.package;Services_Libravatar">Services_Libravatar</link>
+    is a PHP5 library to the
+    <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.libravatar;">Libravatar service</link>
+    that delivers avatar pictures to other websites:
+    It gives you image URLs for email addresses.
+   </para>
+   <para>
+    Libravatar offers several benefits over the classic Gravatar service:
+    It is federated - you can host the avatar server for your mail addresses
+    yourself.
+    It is open source.
+    It can fall back to Gravatar if Libravatar does not have a picture for
+    the email address, making it perfectly backwards compatible.
+    It allows you to give a picture to your OpenID.
+   </para>
+  </abstract>
+ </info>
+
+ <chapter>
+  &package.webservices.services-libravatar.basic;
+ </chapter>
+</book>

Modified: pear/peardoc/trunk/en/package/webservices-entities.xml
===================================================================
--- pear/peardoc/trunk/en/package/webservices-entities.xml	2012-08-08 21:04:09 UTC (rev 327030)
+++ pear/peardoc/trunk/en/package/webservices-entities.xml	2012-08-08 21:19:58 UTC (rev 327031)
@@ -5,6 +5,7 @@
 &package.webservices.services-ebay;
 &package.webservices.services-geonames;
 &package.webservices.services-google;
+&package.webservices.services-libravatar;
 &package.webservices.services-mailman;
 &package.webservices.services-recaptcha;
 &package.webservices.services-technorati;

Modified: pear/peardoc/trunk/entities/global.ent
===================================================================
--- pear/peardoc/trunk/entities/global.ent	2012-08-08 21:04:09 UTC (rev 327030)
+++ pear/peardoc/trunk/entities/global.ent	2012-08-08 21:19:58 UTC (rev 327031)
@@ -55,6 +55,7 @@
 <!ENTITY url.kde 'http://www.kde.org/'>
 <!ENTITY url.kerberos.info 'http://web.mit.edu/kerberos/www/'>
 <!ENTITY url.kerberos.docs 'http://web.mit.edu/kerberos/www/krb5-1.2/krb5-1.2.8/doc/admin_toc.html'>
+<!ENTITY url.libravatar 'https://www.libravatar.org/'>
 <!ENTITY url.libxml 'http://www.xmlsoft.org/'>
 <!ENTITY url.libxml.xmllint 'http://www.xmlsoft.org/xmllint.html'>
 <!ENTITY url.license.apache 'http://www.opensource.org/licenses/apache2.0.php'>

--69fb5bb6fb01c31ac64dcfdb06c196d1662ed5a7--