WordPress.org
Get WordPress

Plugin Directory

Changeset 713642


Ignore:
Timestamp:
05/15/2013 11:28:20 PM (13 years ago)
Author:
digmedia
Message:

updated a few files

File:
1 edited

Legend:

Unmodified
Added
Removed

  • dm-user-tracking-plugin/trunk/faq.html

    r521207 r713642  
    1         How do I set up the plugin?</a><br><br><a href="#What is a shortcode and how do I use one?">
    2         What is a shortcode and how do I use one?</a><br><br><a href="#You're awesome. Can I give you some money?">
    3         You're awesome. Can I give you some money?</a><br><br><a href="#What are GET variables?">
    4         What are GET variables?</a><br><br><a href="#What are POST variables?">
    5         What are POST variables?</a><br><br><a href="#What are Cookies when they aren't a delicious snack?">
    6         What are Cookies when they aren't a delicious snack?</a><br><br><a href="#What is a referrer?">
    7         What is a referrer?</a><br><br><a href="#What is a user agent?">
    8         What is a user agent?</a><br><br><a href="#What is an ip address and why do you have a "real" one?">
    9         What is an ip address and why do you have a "real" one?</a></a><br><br><a href="#How do I print out the log and/or charts?">
    10         How do I print out the log and/or charts?</a><br><br><a href="#Still stuck?">Still stuck? Get in
    11         touch!</a><br><br><h2>Answers</h2><div id="How do I set up the plugin?" class="question"><h3>How do I set up the
    12             plugin?</h3><div class="faq-content">There really isn't any setting up to be done. Once installed the plugin
    13             will happily chug along on its own without any need for configuration. You can, however, use the somewhat
    14             extensive settings in the Settings menu to customise your experience with the DM User Tracking plugin.
    15             They all have explanations of what they do associated with them. If you are confused by any of the options,
    16             however, drop me an email and I'll work on improving the documentation :) [email protected] <br><br><a
    17                 href="#top" class="button-secondary">Back to top</a></div></div><div id="What is a shortcode and how do I use one?" class="question"><h3>What is a shortcode and how do I use one?</h3><div class="faq-content">A shortcode is a bit of text you can put in your posts that get filtered and changed into something useful. For example, a lot of forums use "bbcode" which stands for bulletin board code, which is a type of short code. They have tags like [b] for bold, [i] for italic and so on. <br>
    18 <br>
    19 If you have the setting enabled, DM User Tracking allows you to post the 3 pie charts found in the stats section to your blog (they will update dynamically, too). Here are some examples of how to use the shortcodes for you:<br>
    20 <blockquote><br>
    21 [lbakut type="browser" title="Browser Stats" width="600" height="300"]<br>
    22 </blockquote><br>
    23 Most of the syntax is self explanatory. The width and height are in pixels, they are optional and will default to 700x350 if left out and you can't exceed 300,000 total pixels in the image due to restrictions on the Google Charts API so make sure width*height is less than 300,000. <br>
    24 <br>
    25 The "type" attribute can be one of three values: "browser", "os" or "pageviews" for each of the charts respectively. This is the only mandatory attribute. <br>
    26 <br>
    27 The "title" attribute is the heading on the image. If left blank no title will be shown. <br><br><a href="#top"
    28     class="button-secondary">Back to top</a></div></div><div id="You&#39;re awesome. Can I give you some money?"
    29     class="question"><h3>You're awesome. Can I give you some money?</h3><div class="faq-content">You're too kind! Of
    30         course you can, there is a Donate link at the top of this page that will take you to a page with a link to my
    31         PayPal on it. Donations are greatly appreciated and will find you a place in my heart. Right next to my love of
    32         programming and The Big Bang Theory. <br><br><a href="#top" class="button-secondary">Back to top</a></div></div><div id="What are GET variables?" class="question"><h3>What are GET variables?</h3><div class="faq-content">GET variables refer to variables that are sent to a web server in the URL. If you're somewhat new to all of this computer lark, I will do my best to explain: <br>
    33 <br>
    34 A URL is a "Uniform resource locator". You use them every single time you browse the web, here are some examples of a URL: http://lbak.co.uk, http://facebook.com, http://google.com. They're web addresses, if you want. Sometimes you will see a url like this: http://lbak.co.uk?var1=hello. The question mark initiates the start of the GET variables and the ampersand symbol (&amp;) separates them. They are simple key=value pairs that get passed to the web server to help make content more dynamic and catered to you. <br>
    35 <br>
    36 In the DM User Tracking plugin these key=value pars will be displayed to you without the question marks or the ampersands. Just a list of key=value pairs that got sent in that page click. <br>
    37 <br><br><a href="#top" class="button-secondary">Back to top</a></div></div><div id="What are POST variables?" class="question"><h3>What are POST variables?</h3><div class="faq-content">POST variables are very similar to GET variables except that they are not passed in the URL and they have less limitations. GET variables, for examples, are subject to length limits. I'm not sure of the exact numbers off the top of my head but POST variables are a lot less limited in length (to the point where they are considered more or less unlimited). <br>
    38 <br>
    39 Form data is very often submitted to web pages as POST data. <br>
    40 <br><br><a href="#top" class="button-secondary">Back to top</a></div></div><div id="What are Cookies when they aren&#39;t a delicious snack?" class="question"><h3>What are Cookies when they aren't a delicious snack?</h3><div class="faq-content">Ahh, cookies. There are a lot of misconceptions and myths about cookies. Here's what they really are: <br>
    41 <br>
    42 When your web browser accesses a web page, that webpage can ask your web browser to save some information on your hard drive for future reference. Don't worry, as far as I am aware there aren't currently any ways to install virusses using cookies but they can be used to kind of track your internet usage. <br>
    43 <br>
    44 Your web browser will have a folder deep inside your hard drive somewhere that contains a whole host of small text files containing what will most likely look like gibberish. Very often websites will want to keep what is called "session data" on you (data stored until you close your browser or are inactive for a certain amount of time, usually 15 minutes), shopping sites do this to store baskets or recommend items that would interest you. Session data is saved as a long, seemingly meaningless string of characters with the key "PHPSESSID" or something like that (it will differ if the site does not use PHP as a scripting language or decides to specify their own names for sessions). This is actually just a unique identifier for the server to recognise and retrive the right data for. <br>
    45 <br>
    46 In conclusion, cookies are just variables that web pages want to save that last through browser sessions. They tend not
    47 to be malicious and there is no real reason to be scared of them. <br><br><a href="#top" class="button-secondary">Back
    48     to top</a></div></div><div id="What is a referrer?" class="question"><h3>What is a referrer?</h3><div
    49 class="faq-content">A referrer is something sent by your browser to tell the next web page where you came from. It is an
    50 optional thing, though, and some browsers choose not to send it or they send you misinformation. It isn't recommended to
    51 trust it. <br><br><a href="#top" class="button-secondary">Back to top</a></div></div><div id="What is a user agent?" class="question"><h3>What is a user agent?</h3><div class="faq-content">User Agent is another piece of information that your browser sends to web pages. It is a unique string that identifies what web browser and operating system you are using. There is a project called the "PHP Browscap" which aims to try and identify the browser capabilities of every browser out there and they are doing a really good job. DM User Tracking uses the PHP Browscap technology (automatically downloads updates every week for you, too, so you've always got the up to date info on web browsers) that is worked on by a guy called Gary Keith and can be found here: <a href="http://code.google.com/p/phpbrowscap/" target="_blank">http://code.google.com/p/phpbrowscap/</a>. <br>
    52 <br>
    53 Note: DM User Tracking only uses his definitions file, not his class file. Plans to use his class file may formulate
    54 at some point in the future. <br><br><a href="#top" class="button-secondary">Back to top</a></div></div><div id="What is an ip address and why do you have a &quot;real&quot; one?" class="question"><h3>What is an ip address and why do you have a "real" one?</h3><div class="faq-content">IP address stands for Internet Protocol Address. Before routers it would uniquely identify your computer for a short period of time but now it will identify you as anyone connecting through the same router as you. This causes some interesting problems on large networks such as schools and Universities. <br>
    55 <br>
    56 An IP address consists of 4 "octets" (sections ranging from 0 to 255). A sample IP address would be 173.194.36.104, which is Google (go on, put it into your web browser if you don't believe me). It is how both clients and servers are identified on the web. Clients are likely to change their IP addresses from time to time (it just happens) but servers tend to stick with a "static" ip address that tends not to change. <br>
    57 <br>
    58 The reason that there is a column called "real" ip address is because of something called a "proxy". A proxy will
    59 attempt to mask your IP address from web servers so you can browse the internet anonymously. Some of these proxies,
    60 however, will send your real IP address in a subtle way. DM User Tracking checks for the tell tale signs of proxy
    61 usage and attempts to log the "real" ip address of the user. The field will generally be empty, though, because most
    62 proxies don't reveal your real IP address so I wouldn't hold out much hope for catching those pesky proxy using
    63 spammers. Attempts are being made to find better methods of detecting real IP addresses, though, and may be released
    64 into this plugin in future.<a href="#top" class="button-secondary">Back to top</a></div></div><div id="How do I print out the log and/or charts?" class="question"><h3>How do I print out the log and/or charts?</h3><div class="faq-content">To embed the stats charts on your page you need to use some shortcodes.<br>
    65 <br>
    66 OS Chart: [lbakut type="os"]<br>
    67 Browser Chart: [lbakut type="browser"]<br>
    68 Pagewviews Chart: [lbakut type="pageviews"]<br>
    69 <br>
    70 They support a variety of attributes: title, height and width. <br>
    71 <br>
    72 Here's an example of using all three:<br>
    73 <br>
    74 [lbakut type="os" height="300" width="400" title="OS Breakdown Chart"]<br>
    75 <br>
    76 <br>
    77 At the moment, you cannot include logs in posts. There are no plans to add such a feature in future, either.<br><br><a
    78     href="#top" class="button-secondary">Back to top</a></div></div><div id="Still stuck?" class="question">
     1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
     2<html>
     3<head>
     4  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     5  <meta http-equiv="Content-Style-Type" content="text/css">
     6  <title></title>
     7  <meta name="Generator" content="Cocoa HTML Writer">
     8  <meta name="CocoaVersion" content="1138.51">
     9  <style type="text/css">
     10    p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Times}
     11    p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Times; min-height: 14.0px}
     12    p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Times; color: #0000ee}
     13    span.s1 {text-decoration: underline}
     14    span.s2 {text-decoration: underline ; color: #0000ee}
     15  </style>
     16</head>
     17<body>
     18<p class="p1">How do I set up the plugin?</p>
     19<p class="p2"><br></p>
     20<p class="p3"><span class="s1">What is a shortcode and how do I use one?</span></p>
     21<p class="p2"><br></p>
     22<p class="p3"><span class="s1">You're awesome. Can I give you some money?</span></p>
     23<p class="p2"><br></p>
     24<p class="p3"><span class="s1">What are GET variables?</span></p>
     25<p class="p2"><br></p>
     26<p class="p3"><span class="s1">What are POST variables?</span></p>
     27<p class="p2"><br></p>
     28<p class="p3"><span class="s1">What are Cookies when they aren't a delicious snack?</span></p>
     29<p class="p2"><br></p>
     30<p class="p3"><span class="s1">What is a referrer?</span></p>
     31<p class="p2"><br></p>
     32<p class="p3"><span class="s1">What is a user agent?</span></p>
     33<p class="p2"><br></p>
     34<p class="p3"><span class="s1">What is an ip address and why do you have a "real" one?</span></p>
     35<p class="p2"><br></p>
     36<p class="p3"><span class="s1">How do I print out the log and/or charts?</span></p>
     37<p class="p2"><br></p>
     38<p class="p3"><span class="s1">Still stuck? Get in touch!</span></p>
     39<p class="p2"><br></p>
     40<h2 style="margin: 0.0px 0.0px 14.0px 0.0px; font: 18.0px Times"><b>Answers</b></h2>
     41<h3 style="margin: 0.0px 0.0px 14.0px 0.0px; font: 14.0px Times"><b>How do I set up the plugin?</b></h3>
     42<p class="p1">There really isn't any setting up to be done. Once installed the plugin will happily chug along on its own without any need for configuration. You can, however, use the somewhat extensive settings in the Settings menu to customise your experience with the DM User Tracking plugin. They all have explanations of what they do associated with them.</p>
     43<p class="p2"><br></p>
     44<p class="p3"><span class="s1">Back to top</span></p>
     45<h3 style="margin: 0.0px 0.0px 14.0px 0.0px; font: 14.0px Times"><b>What is a shortcode and how do I use one?</b></h3>
     46<p class="p1">A shortcode is a bit of text you can put in your posts that get filtered and changed into something useful. For example, a lot of forums use "bbcode" which stands for bulletin board code, which is a type of short code. They have tags like [b] for bold, [i] for italic and so on.<span class="Apple-converted-space"> </span></p>
     47<p class="p2"><br></p>
     48<p class="p1">If you have the setting enabled, DM User Tracking allows you to post the 3 pie charts found in the stats section to your blog (they will update dynamically, too). Here are some examples of how to use the shortcodes for you:</p>
     49<p class="p2"><br></p>
     50<p class="p1">[lbakut type="browser" title="Browser Stats" width="600" height="300"]</p>
     51<p class="p2"><br></p>
     52<p class="p1">Most of the syntax is self explanatory. The width and height are in pixels, they are optional and will default to 700x350 if left out and you can't exceed 300,000 total pixels in the image due to restrictions on the Google Charts API so make sure width*height is less than 300,000.<span class="Apple-converted-space"> </span></p>
     53<p class="p2"><br></p>
     54<p class="p1">The "type" attribute can be one of three values: "browser", "os" or "pageviews" for each of the charts respectively. This is the only mandatory attribute.<span class="Apple-converted-space"> </span></p>
     55<p class="p2"><br></p>
     56<p class="p1">The "title" attribute is the heading on the image. If left blank no title will be shown.<span class="Apple-converted-space"> </span></p>
     57<p class="p2"><br></p>
     58<p class="p3"><span class="s1">Back to top</span></p>
     59<h3 style="margin: 0.0px 0.0px 14.0px 0.0px; font: 14.0px Times"><b>What are GET variables?</b></h3>
     60<p class="p1">GET variables refer to variables that are sent to a web server in the URL. If you're somewhat new to all of this computer lark, I will do my best to explain:<span class="Apple-converted-space"> </span></p>
     61<p class="p2"><br></p>
     62<p class="p1">A URL is a "Uniform resource locator". You use them every single time you browse the web, here are some examples of a URL: http://lbak.co.uk, http://facebook.com, http://google.com. They're web addresses, if you want. Sometimes you will see a url like this: http://lbak.co.uk?var1=hello. The question mark initiates the start of the GET variables and the ampersand symbol (&amp;) separates them. They are simple key=value pairs that get passed to the web server to help make content more dynamic and catered to you.<span class="Apple-converted-space"> </span></p>
     63<p class="p2"><br></p>
     64<p class="p1">In the DM User Tracking plugin these key=value pars will be displayed to you without the question marks or the ampersands. Just a list of key=value pairs that got sent in that page click.<span class="Apple-converted-space"> </span></p>
     65<p class="p2"><br></p>
     66<p class="p2"><br></p>
     67<p class="p3"><span class="s1">Back to top</span></p>
     68<h3 style="margin: 0.0px 0.0px 14.0px 0.0px; font: 14.0px Times"><b>What are POST variables?</b></h3>
     69<p class="p1">POST variables are very similar to GET variables except that they are not passed in the URL and they have less limitations. GET variables, for examples, are subject to length limits. I'm not sure of the exact numbers off the top of my head but POST variables are a lot less limited in length (to the point where they are considered more or less unlimited).<span class="Apple-converted-space"> </span></p>
     70<p class="p2"><br></p>
     71<p class="p1">Form data is very often submitted to web pages as POST data.<span class="Apple-converted-space"> </span></p>
     72<p class="p2"><br></p>
     73<p class="p2"><br></p>
     74<p class="p3"><span class="s1">Back to top</span></p>
     75<h3 style="margin: 0.0px 0.0px 14.0px 0.0px; font: 14.0px Times"><b>What are Cookies when they aren't a delicious snack?</b></h3>
     76<p class="p1">Ahh, cookies. There are a lot of misconceptions and myths about cookies. Here's what they really are:<span class="Apple-converted-space"> </span></p>
     77<p class="p2"><br></p>
     78<p class="p1">When your web browser accesses a web page, that webpage can ask your web browser to save some information on your hard drive for future reference. Don't worry, as far as I am aware there aren't currently any ways to install virusses using cookies but they can be used to kind of track your internet usage.<span class="Apple-converted-space"> </span></p>
     79<p class="p2"><br></p>
     80<p class="p1">Your web browser will have a folder deep inside your hard drive somewhere that contains a whole host of small text files containing what will most likely look like gibberish. Very often websites will want to keep what is called "session data" on you (data stored until you close your browser or are inactive for a certain amount of time, usually 15 minutes), shopping sites do this to store baskets or recommend items that would interest you. Session data is saved as a long, seemingly meaningless string of characters with the key "PHPSESSID" or something like that (it will differ if the site does not use PHP as a scripting language or decides to specify their own names for sessions). This is actually just a unique identifier for the server to recognise and retrive the right data for.<span class="Apple-converted-space"> </span></p>
     81<p class="p2"><br></p>
     82<p class="p1">In conclusion, cookies are just variables that web pages want to save that last through browser sessions. They tend not to be malicious and there is no real reason to be scared of them.<span class="Apple-converted-space"> </span></p>
     83<p class="p2"><br></p>
     84<p class="p3"><span class="s1">Back to top</span></p>
     85<h3 style="margin: 0.0px 0.0px 14.0px 0.0px; font: 14.0px Times"><b>What is a referrer?</b></h3>
     86<p class="p1">A referrer is something sent by your browser to tell the next web page where you came from. It is an optional thing, though, and some browsers choose not to send it or they send you misinformation. It isn't recommended to trust it.<span class="Apple-converted-space"> </span></p>
     87<p class="p2"><br></p>
     88<p class="p3"><span class="s1">Back to top</span></p>
     89<h3 style="margin: 0.0px 0.0px 14.0px 0.0px; font: 14.0px Times"><b>What is a user agent?</b></h3>
     90<p class="p1">User Agent is another piece of information that your browser sends to web pages. It is a unique string that identifies what web browser and operating system you are using. There is a project called the "PHP Browscap" which aims to try and identify the browser capabilities of every browser out there and they are doing a really good job. DM User Tracking uses the PHP Browscap technology (automatically downloads updates every week for you, too, so you've always got the up to date info on web browsers) that is worked on by a guy called Gary Keith and can be found here: <a href="http://code.google.com/p/phpbrowscap/"><span class="s2">http://code.google.com/p/phpbrowscap/</span></a>.<span class="Apple-converted-space"> </span></p>
     91<p class="p2"><br></p>
     92<p class="p1">Note: DM User Tracking only uses his definitions file, not his class file. Plans to use his class file may formulate at some point in the future.<span class="Apple-converted-space"> </span></p>
     93<p class="p2"><br></p>
     94<p class="p3"><span class="s1">Back to top</span></p>
     95<h3 style="margin: 0.0px 0.0px 14.0px 0.0px; font: 14.0px Times"><b>What is an ip address and why do you have a "real" one?</b></h3>
     96<p class="p1">IP address stands for Internet Protocol Address. Before routers it would uniquely identify your computer for a short period of time but now it will identify you as anyone connecting through the same router as you. This causes some interesting problems on large networks such as schools and Universities.<span class="Apple-converted-space"> </span></p>
     97<p class="p2"><br></p>
     98<p class="p1">An IP address consists of 4 "octets" (sections ranging from 0 to 255). A sample IP address would be 173.194.36.104, which is Google (go on, put it into your web browser if you don't believe me). It is how both clients and servers are identified on the web. Clients are likely to change their IP addresses from time to time (it just happens) but servers tend to stick with a "static" ip address that tends not to change.<span class="Apple-converted-space"> </span></p>
     99<p class="p2"><br></p>
     100<p class="p1">The reason that there is a column called "real" ip address is because of something called a "proxy". A proxy will attempt to mask your IP address from web servers so you can browse the internet anonymously. Some of these proxies, however, will send your real IP address in a subtle way. DM User Tracking checks for the tell tale signs of proxy usage and attempts to log the "real" ip address of the user. The field will generally be empty, though, because most proxies don't reveal your real IP address so I wouldn't hold out much hope for catching those pesky proxy using spammers. Attempts are being made to find better methods of detecting real IP addresses, though, and may be released into this plugin in future.<span class="s2">Back to top</span></p>
     101<h3 style="margin: 0.0px 0.0px 14.0px 0.0px; font: 14.0px Times"><b>How do I print out the log and/or charts?</b></h3>
     102<p class="p1">To embed the stats charts on your page you need to use some shortcodes.</p>
     103<p class="p2"><br></p>
     104<p class="p1">OS Chart: [lbakut type="os"]</p>
     105<p class="p1">Browser Chart: [lbakut type="browser"]</p>
     106<p class="p1">Pagewviews Chart: [lbakut type="pageviews"]</p>
     107<p class="p2"><br></p>
     108<p class="p1">They support a variety of attributes: title, height and width.<span class="Apple-converted-space"> </span></p>
     109<p class="p2"><br></p>
     110<p class="p1">Here's an example of using all three:</p>
     111<p class="p2"><br></p>
     112<p class="p1">[lbakut type="os" height="300" width="400" title="OS Breakdown Chart"]</p>
     113<p class="p2"><br></p>
     114<p class="p2"><br></p>
     115<p class="p1">At the moment, you cannot include logs in posts. There are no plans to add such a feature in future, either.</p>
     116<p class="p2"><br></p>
     117<p class="p3"><span class="s1">Back to top</span></p>
     118<p class="p2"><br></p>
     119</body>
     120</html>
Note: See TracChangeset for help on using the changeset viewer.