<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.20" xml:lang="en-US">
  <compounddef id="md__home_odroid_lomiri_libusermetrics-git_src_libusermetrics_doc_pages_mainpage" kind="page">
    <compoundname>md__home_odroid_lomiri_libusermetrics-git_src_libusermetrics_doc_pages_mainpage</compoundname>
    <title>Welcome to Libusermetrics</title>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
<para>Libusermetrics enables apps to locally store interesting numerical data for later presentation. For example in the Ubuntu Greeter &quot;flower&quot; infographic.</para>
<para><itemizedlist>
<listitem><para>All data is stored locally in /var/usermetrics/.</para>
</listitem><listitem><para>No data is centrally collected via a web-serivice or otherwise, and no data is sent over the internet.</para>
</listitem></itemizedlist>
</para>
<para>The only data that can be stored is numerical, for example &quot;number of
e-mails&quot; or &quot;number of pictures taken&quot;. No personally identifying information is stored using this library.</para>
<para><bold>WARNING:</bold> This API should be considered private, and is only for use by first party applications at present. It may change or be removed at any time.</para>
<sect1 id="md__home_odroid_lomiri_libusermetrics-git_src_libusermetrics_doc_pages_mainpage_1autotoc_md5">
<title>Getting and installing libusermetrics</title>
<sect2 id="md__home_odroid_lomiri_libusermetrics-git_src_libusermetrics_doc_pages_mainpage_1autotoc_md6">
<title>Using pre-built packages</title>
<para>If you just want to try out libusermetrics, or write user metrics sources, then the easiest way is to use the <ref refid="installing__prebuilt_8md" kindref="compound">pre-built packages</ref>.</para>
</sect2>
<sect2 id="md__home_odroid_lomiri_libusermetrics-git_src_libusermetrics_doc_pages_mainpage_1autotoc_md7">
<title>Building and installing from source</title>
<para>If you are curious about libusermetrics&apos;s internals or intend to contribute to it, you should <ref refid="building__source_8md" kindref="compound">get the source and build it</ref>.</para>
</sect2>
</sect1>
<sect1 id="md__home_odroid_lomiri_libusermetrics-git_src_libusermetrics_doc_pages_mainpage_1autotoc_md8">
<title>Getting involved</title>
<para>The best place to ask questions and discuss about libusermetrics is the #ubuntu-touch IRC channel on freenode.</para>
<para>The libusermetrics project is hosted on Launchpad: <ulink url="https://launchpad.net/libusermetrics">https://launchpad.net/libusermetrics</ulink></para>
<para>Please file bug reports at: <ulink url="http://bugs.launchpad.net/libusermetrics">http://bugs.launchpad.net/libusermetrics</ulink></para>
</sect1>
<sect1 id="md__home_odroid_lomiri_libusermetrics-git_src_libusermetrics_doc_pages_mainpage_1autotoc_md9">
<title>Writing metric data sources</title>
<para><itemizedlist>
<listitem><para><ref refid="namespaceUserMetricsInput" kindref="compound">Libusermetrics Input API Documentation</ref></para>
</listitem></itemizedlist>
</para>
<para>For simple metrics which only want to increment a counter, see the following examples:</para>
<para><itemizedlist>
<listitem><para><ref refid="MetricManagerIncrementToday_8cpp-example" kindref="compound">MetricManagerIncrementToday.cpp: A simple Qt-based metric</ref></para>
</listitem><listitem><para><ref refid="MetricManagerIncrementTodayCAPI_8c-example" kindref="compound">MetricManagerIncrementTodayCAPI.c: A simple C-based metric</ref></para>
</listitem></itemizedlist>
</para>
<para>For simple metrics which only want to update today&apos;s value, but cannot simply increment it, see the following examples:</para>
<para><itemizedlist>
<listitem><para><ref refid="MetricManagerUpdateToday_8cpp-example" kindref="compound">MetricManagerUpdateToday.cpp: A simple Qt-based metric</ref></para>
</listitem><listitem><para><ref refid="MetricManagerUpdateTodayCAPI_8c-example" kindref="compound">MetricManagerUpdateTodayCAPI.c: A simple C-based metric</ref></para>
</listitem></itemizedlist>
</para>
<para>For more sophisticated metrics, which wish to update the history of the metric, for example if the user has been offline for a week. Please see the following examples:</para>
<para><itemizedlist>
<listitem><para><ref refid="MetricManagerAdvanced_8cpp-example" kindref="compound">MetricManagerAdvanced.cpp: A Qt-based metric</ref></para>
</listitem><listitem><para><ref refid="MetricManagerAdvancedCAPI_8c-example" kindref="compound">MetricManagerAdvancedCAPI.c: A C-based metric</ref></para>
</listitem></itemizedlist>
</para>
</sect1>
<sect1 id="md__home_odroid_lomiri_libusermetrics-git_src_libusermetrics_doc_pages_mainpage_1autotoc_md10">
<title>Writing a presentation application</title>
<para>To write a metric presentation application, there is a Qt API.</para>
<para><itemizedlist>
<listitem><para><ref refid="namespaceUserMetricsOutput" kindref="compound">Libusermetrics Output API Documentation</ref></para>
</listitem><listitem><para>A good example to refer to is the <ulink url="https://bazaar.launchpad.net/~unity-team/unity8/trunk/view/head:/Greeter/Infographics.qml">infographics</ulink> for the Unity8 greeter. </para>
</listitem></itemizedlist>
</para>
</sect1>
    </detaileddescription>
  </compounddef>
</doxygen>
