make all pages valid, add screenshots
[mysocials] / www / api.html
index aaf0b7c..fe8defe 100644 (file)
@@ -1,5 +1,6 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html 
+       PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <p> MySocials driver is provided as a shared library (libmsa&lt;service_name&gt;.so). Structure <b>msa_module *d</b> includes information about the driver (name, identifier, pointers to driver functions). This structure is filled during initialization of the driver.
        </p>
        <h3>Driver interface</h3>
-       <p>Driver interface is described in file interface.h and consists of 4 functions:
+       <p>Driver interface is described in file interface.h and consists of 4 functions:</p>
        <ul>
        <li><b>msa_module_init(struct msa_module* d)</b> — driver initialization;</li>
        <li><b>msa_module_get_info(struct msa_module* d)</b> — getting information about driver;</li>
        <li><b>msa_module->send(xmlDocPtr request, xmlDocPtr* response, const struct msa_module* info)</b> — request sending and response receiveing;</li>
        <li><b>msa_module->shutdown(const struct msa_module*)</b> - driver shutdown.</li>
        </ul>
-       
        <h3>Driver initialization and shutting down</h3>
-       Driver initialization is performed by using <b>msa_module_init(struct msa_module* d)</b> function. Instance of structure which stores profile setting is created during initialization. Parameter d stores identifier of this instance. 
-       <br>
+       <p>Driver initialization is performed by using <b>msa_module_init(struct msa_module* d)</b> function. Instance of structure which stores profile setting is created during initialization. Parameter d stores identifier of this instance. 
+       <br />
        Function <b>msa_module->shutdown(const struct msa_module*)</b> is used during program termination. 
-
+       </p>
        <h3>Interaction with driver</h3>
-
+       <p>
        Fuction <b>msa_module->send(xmlDocPtr request, xmlDocPtr* response, const struct msa_module* info)</b> is used to perform requests to the driver. 
 Parameter <i>request</i> is a request in XML format. Description of structure of sending and receiveing data is described <a>here</a>.
 Parameter <i>response</i> contains driver response in XML format.
@@ -87,7 +87,7 @@ Function <b>msa_module_get_info(struct msa_module* d)</b> is used to get informa
        <h2>MySocials driver data structures</h2>
 
        <p>Here you can see description of data structures which are used by MySocials driver. These structures are declared in <b>mysocials_driver.h</b> file which is available for other applications from mysocials-dev package.  
-
+       </p>
        <h3>Enumerations</h3>
        <h4>Error codes</h4>
        <pre class="c" style="font-family:monospace;"><span style="color: #000000; font-weight: bold;">enum</span> error_type <span style="color: #009900;">&#123;</span>
@@ -167,6 +167,7 @@ Function <b>msa_module_get_info(struct msa_module* d)</b> is used to get informa
        </ul>
 
        <p>Following classes are supported:
+       </p>
        <ul>
        <li><i>settings:</i> class for working with settings</li>
        <li><i>profile:</i> class for receiving data about user's profile</li>
@@ -177,8 +178,7 @@ Function <b>msa_module_get_info(struct msa_module* d)</b> is used to get informa
        <li><i>video:</i> class for working with video files</li>
        <li><i>news:</i> class for working with news</li>
        </ul>   
-       </p>
-
+       
        <!-- Settings start -->
        <h3>Settings</h3>
        <h4>getSettings</h4>