Plugin Directory

Changeset 1288622


Ignore:
Timestamp:
11/18/2015 10:48:50 AM (10 years ago)
Author:
ank91
Message:

updated readme.txt 1.7.0

File:
1 edited

Legend:

Unmodified
Added
Removed
  • ank-google-map/tags/1.7.0/readme.txt

    r1288611 r1288622  
    1 === Ank Google Map ===
    2 Tags: google map, responsive, light weight, ank, free, easy map
     1=== Ank Simplified Google Analytics ===
     2Tags: google analytics, tracking, light weight, simple, easy, free , multisite, webmaster
    33Requires at least: 3.8.0
    44Tested up to: 4.3.1
    5 Stable tag: 1.7.0
    6 License: GPLv2 or later
     5Stable tag: 0.9.9
     6License: GPLv2
    77License URI: http://www.gnu.org/licenses/gpl-2.0.html
    8 Contributors:ank91
    9 
    10 Simple and non-bloated WordPress Google Map Plugin.
     8Contributors: ank91
     9
     10The most simplified Google Analytics Plugin for WordPress.
    1111
    1212== Description ==
    13 One Website , One Map , One Marker.
    14 Simple and non-bloated WordPress Google Map Plugin.
    15 Written in pure javascript, no jQuery at all, responsive, configurable, no ads and 100% Free of cost.
    16 
    17 
    18 = Some Features =
    19 * Adjust map canvas height and width.
    20 * Responsive map, auto center map upon resize.
    21 * Configure map canvas border color.
    22 * Disable/Enable map controls.
    23 * Find your location by typing address (Auto complete)
    24 * Change map's language eg:Hindi/Urdu
    25 * Place animated and colorful marker on map
    26 * Place info window on marker with custom text/markup.
    27 * Disable dragging on mobile devices
    28 * Disable mouse wheel zoom
     13
     14Track your WordPress website with Google Analytics service.
     15
     16
     17= Highlights =
     18* Support Universal Google and Classic Analytics both
     19* Using untouched and latest tracking code by Google
     20* Covers most used analytics features
     21* Most lightweight plugin
     22    * Does not provide any dashboard or statistics reporting tool, no one can beat default Google Analytics reporting dashboards
     23    * Follows best WordPress coding practices
     24    * No Ads, No banner, No usage tracking
     25* Simplest user interface
     26    * Single page tab based interface
     27    * Minimal and non confusing settings
     28    * Help links to understand features
     29* Multi-site ready
     30    * Each sub site need to be configured separately
     31    * Each sub site will store its own configuration in database, there is no global settings for this plugin
     32* Translation ready, you are welcome [here](https://github.com/ank91/ank-simplified-ga)
     33* Google webmaster site verification
     34    * No need to install another plugin for Google webmaster verification
     35    * Insert your verification code to generate meta tag
     36* Choose where to place your tracking code
     37    * Ability to place code in header or footer, control priority
     38    * Ability to run tracking code when page loaded
     39
     40= Google Analytics features covered =
     41* Demographics & Interest Reports
     42* Enhanced Link Attribution
     43* Anonymize IPs
     44* Cross-domain user tracking (AllowLinker)
     45* Campaign tracking (AllowAnchor)
     46* Sub-domain tracking
     47* Force SSL
     48
     49= Event Tracking =
     50* Track 404 pages as events
     51* Track searched queries as separate page views
     52* Track email links as events
     53* Track outbound links as events
     54* Track downloads as events
     55* Ability to add your own custom trackers
     56
     57= Exclude users based on their role =
     58* Ability to exclude (stop tracking) for different WordPress roles
     59* Not tracking anything inside wp-admin area.
     60* Not tracking anything in preview mode.
     61
     62= Debug mode =
     63* Allows you to debug tracking code through your browser's inbuilt dev tools
     64* Works only when a administrator user is logged in
     65
     66
     67
     68
     69> <strong>Found bugs ?</strong><br>
     70> I am happy to resolve bugs, report your bugs [here](https://github.com/ank91/ank-simplified-ga/issues)<br>
     71> Please note that support is only available via WordPress forums.
     72
     73
     74> <strong>Still have questions ?</strong><br>
     75> Head over to [FAQ](https://wordpress.org/plugins/ank-simplified-ga/faq/) section first.<br>
     76> You can always use support [forums](https://wordpress.org/support/plugin/ank-simplified-ga).
     77
     78
     79
    2980
    3081== Installation ==
    31 1. Search for 'ank google map' in WordPress Plugin Directory and Download the .zip file & extract it.
    32 2. Upload the folder `ank-google-map` to the `/wp-content/plugins/` directory
     820. Remove existing Google Analytics plugin or disable them.
     831. Search for 'Ank Simplified GA' in WordPress Plugin Directory and Download the .zip file & extract it.
     842. Upload the folder `ank-simplified-ga` to the `/wp-content/plugins/` directory
    33853. Activate the plugin through the 'Plugins List' page in WordPress Admin Area.
    34 4. Configure this plugin via Settings-->Ank Google Map
    35 5. Paste the `[ank_google_map]` short-code in your pages/posts/widgets.
     864. Configure this plugin via Settings-->Google Analytics
     875. Login to Google Analytics account to view stats.
    3688
    3789
    3890== Frequently Asked Questions ==
    3991
    40 = Why did you call it Light Weight ? =
    41 
    42 Because it does not depend on jQuery, written in pure Java Script.
    43 Options page utilize inbuilt jQuery and Color Picker.
    44 It uses inbuilt WP dash-icons in Plugin Options Page.
    45 It uses inbuilt WP text editor on Plugin Options Page.
    46 It does not create additional tables in your database, uses inbuilt 'wp_options' table.
    47 The whole package is about 60 kb. (~15 kb zipped).
    48 
    49 = What do you mean by Non Bloated =
    50 
    51 There are many of Map plugins in plugin directory, but most of them not written well.
    52 Means they put lots of java script (uncompressed) code on every page of your website.
    53 They also loads jquery file before them which effects your page speed.
    54 This plugin will enqueue its js files on the required page only.
    55 It does not depends on external js library like: jQuery.
    56 
    57 = What is the short-code for this plugin =
    58 
    59 `[ank_google_map]`
    60 
    61 = Map does not shown well on front-end =
    62 
    63 Add this css code to your theme's style.css file to fix this
    64 
    65 `
    66 .gmnoprint img, #agm_map_canvas img { max-width: none; }
    67 
    68 `
    69 = Shortcode does not work in text widget =
    70 
    71 Add this line to your theme's functions.php
    72 `add_filter( 'widget_text', 'do_shortcode' );`
     92
     93= What is different with this plugin ? =
     94
     95WordPress plugin directory already filled with many of these kind of plugins.
     96But not all are optimized for performance.
     97Most of them lacks some features, while some of them cover unused features.
     98
     99This plugin was developed to provide most used feature in one place without compromising the speed.
     100So give it a try , i am sure you will not regret for your decision.
     101
     102
     103= Tracking code not shown up in front end =
     104
     105There may be several reasons for this.
     106
     107* Make sure you have entered a valid tracking ID.
     108* Check if tracking is not disabled for current logged in user type.
     109* Try to flush/delete your site cache.
     110* Try re-installing the plugin.
     111
    73112
    74113= Changes does not reflect after saving settings ? =
    75114
    76 Are you using some Cache/Performance plugin (eg:WP Super Cache/W3 Total Cache) ?
    77 Then flush your WP cache and refresh target page.
     115Are you using some Cache/Performance plugin (eg: WP Super Cache/W3 Total Cache) ?
     116
     117Then flush your WP cache after saving settings.
    78118
    79119= Where does it store settings and options ? =
    80120
    81 WP Database->wp-options->ank_google_map.
     121WP Database->wp-options->asga_options.
     122
    82123Uses a Single Row, stored in array for faster access.
    83124
    84 = From where does it loads additional Marker (colored) images ? =
    85 
    86 Every marker image is loaded from official Google Server.
    87125
    88126= What if i uninstall/remove this plugin? =
    89127
    90128No worry! It will remove its traces from database upon uninstall.
    91 You have to remove short-code from your pages by yourself.
    92 
    93 = How do i enter correct language code ? =
    94 
    95 You can force google to load a specific language for all visitors.
    96 Get latest supported language code list from [here](https://developers.google.com/maps/faq#languagesupport).
    97 If you don't specify language code then google will try to load the language requested by visitor's web browser.
    98 
    99 = How to make it responsive =
    100 
    101 Set Map Canvas Width to 100 %. Map will auto center upon resize.
    102 
    103 = I don't want border on map canvas =
    104 
    105 Leave the color field empty and it will not be applied.
     129
     130It will also disable tracking by removing the code from front-end.
     131
     132= Where to find my GA Tracking ID ? =
     133
     134Just go [here](https://support.google.com/analytics/answer/1032385).
     135
     136= Am i using Classic or Universal GA ? =
     137
     138[This](https://support.google.com/analytics/answer/4457764) might help.
     139
     140= What is debugging mode, How do i use it ? =
     141
     142Debugging mode allows you to troubleshot problems with Google Analytics web tracking.
     143Once you enable this mode. Open up your site homepage and press F12 to open developer tools,
     144now switch to console tab to see detailed messages.
     145
     146You can read more about troubleshooting [here](https://developers.google.com/analytics/resources/articles/gaTrackingTroubleshooting#gaDebug)
     147
     148Don't forget to disable this mode in production.
     149
     150This mode is only available for administrators only when they are logged-in to WordPress dashboard.
     151
     152= How does it work for multi-site ? =
     153
     154You need to configure the plugin for each of sub-site individually.
    106155
    107156= Did you test it with old version of WordPress ? =
    108157
    109 No, tested with v4.0+ (latest as of now) only. So i recommend you to upgrade to latest WordPress today.
    110 
    111 = Do you hate jQuery ? =
    112 
    113 No, I love it as like you. But I prefer faster websites.
    114 
    115 
    116 = Is Google Map API is free. =
    117 
    118 Until we break its terms and conditions.
    119 
    120 Google Map API V3 does not need an API Key.
    121 
    122 
    123 = Failed to load Google Map. Refresh this page and try again. What is this ? =
    124 
    125 It means 'Google Map API' is not loaded.
    126 
    127 Possible reasons are -
    128 
    129 * No internet connection. (Internet is must).
    130 * Other Plugin's java script conflict. (Try disabling them one by one).
    131 * This plugin has a problem/bug. (Report it now).
     158I uses latest version WordPress during development.
     159So i recommend you to upgrade to latest WordPress today.
     160
     161
     162= Is Google Analytics service free. =
     163
     164Yes, There is paid version of Google Analytics also.
     165
     166Read more [here](https://developers.google.com/analytics/devguides/collection/analyticsjs/limits-quotas).
     167
     168
     169= How do i enter Google Webmaster verification code ? =
     170
     171Login to Google Webmaster [console](https://www.google.com/webmasters/tools/home?hl=en), get the verification code from there
     172
     173Checkout this [link](http://googlewebmastercentral.blogspot.in/2011/02/linking-google-analytics-to-webmaster.html)
     174OR
     175You can search google like 'Linking google analytics to webmaster'
     176
    132177
    133178
    134179= Future Plans ? =
    135 
    136 * I18n for Option Page.
    137 * Multiple Maps with Multiple Markers.
     180* OAuth
     181* More options may be.
     182
     183
     184
     185== Screenshots ==
     1861. General Options
     1872. Advanced Options
     1883. Tracking/Monitor Options
     1894. Control code execution
     1905. Troubleshooting Options
     191
     192
     193== Upgrade Notice ==
     194
     195
     196== Changelog ==
     197
     198= 0.9.9 =
     199* Minimum php version required 5.3.0
     200* Updated docs
     201* Several speed improvements
     202
     203= 0.9.8 =
     204* Fix: A bug while checking for event tracking js
     205
     206= 0.9.7 =
     207* Code organization
     208* Minor bug fixes
     209* Tweak Docs
     210
     211= 0.9.6 =
     212* New: Event tracking, tracking outbound links , track downloads
     213
     214= 0.9.5 =
     215* Bug Fix: Admin role was not being ignored
     216
     217= 0.9.4 =
     218* Bug Fix: Fixed a bug with handling different database options
     219
     220= 0.9.3 =
     221* Post release: Minor tweaks and fixes, sorry for two updates in a single day
     222* Updates screen-shots
     223* Updated docs
     224
     225
     226= 0.9.2 =
     227* Feature: Ability to link to Google Webmaster
     228
     229= 0.9.1 =
     230* Minor Fix : Debugging info was not shown for classic ga when 'On page load' is enabled
     231* Code improvements
     232
     233= 0.9.0 =
     234* Bug Fix - Rollback transient js feature
     235
     236= 0.8.7 =
     237* Fixed translation issues
     238* Code organization
     239* UI Fixes
     240
     241= 0.8.6 =
     242* Fix text domain issues
     243* Changed text-domain
     244* Tested up to WordPress v4.3.1
     245
     246= 0.8.5 =
     247* Plugin is now translation ready
     248* Fixed typos
     249* Tested up to WordPress v4.2.5
     250
     251= 0.8.4 =
     252* More debugging options
     253* Fixed bugs
     254
     255= 0.8.3 =
     256* Some new options added
     257* Minified admin js
     258
     259= 0.8.2 =
     260* Custom Trackers
     261* Return to same tab upon save
     262* Minor adjustments
     263
     264= 0.8.1 =
     265* Track user engagement option removed in favor of [this](http://riveted.parsnip.io/)
     266
     267= 0.8 =
     268* Bug fixes
     269
     270= 0.7 =
     271* Improved upgrade paths
     272
     273= 0.6 =
     274* Cache processed js code for faster access
     275* More docs coming soon
     276
     277= 0.5 =
     278* Plugin name changed to 'Ank Simplified Google Analytics'
     279* New tabbed interface
     280* Force SSL
     281* User engagement tracking
     282* Control tracking code execution
     283
     284= 0.4 =
     285* Debugging mode
     286* Updated docs
     287
     288= 0.3 =
    138289* Multi-site support
    139 * Improved upgrade paths.
    140 
    141 == Upgrade Notice ==
    142 
    143 No big changes yet in this plugin, so go ahead and upgrade to new version whenever i release.
    144 It just a matter of a second. It will cost not more than 15 KB.
    145 
    146 == Screenshots ==
    147 1. Plugin Option Page Screen
    148 
    149 == Changelog ==
    150 
    151 = 1.7.0 =
    152 * Min php version 5.3.0
    153 * Removed screen options, always load text editor
    154 * Removed bloated code, speed improvement
    155 
    156 = 1.6.3 =
    157 * Fix Option page not working due to wrong js url
    158 
    159 = 1.6.2 =
    160 * Tested upto WordPress 4.3.1
    161 * Fix links and updated docs
    162 
    163 = 1.6.1 =
    164 * Disable drag on mobile
    165 * Disable Mouse wheel zoom
    166 
    167 = 1.6.0 =
    168 * Tested upto wp v4.2.2
    169 * Minor adjustments
    170 
    171 = 1.5.9 =
    172 * Execution Speed Improvements
    173 
    174 = 1.5.8 =
    175 * Tested upto WP v4.1
    176 * Enqueue the minified version of js file to option page.
    177 * Miner fixes
    178 
    179 = 1.5.7 =
    180 * Option page has it own separate class  (easy to manage code)
    181 * Few More Improvements
    182 
    183 = 1.5.6 =
    184 * Add Plugin version to database for future use.
    185 * Java Script Localization for options page.
    186 * Store options page JS code to a separate file. (allow browsers to cache this file)
    187 * Now we enqueue our main JS file on target page. (allow browsers to cache this file)
    188 * JS priority parameter has been removed from short-code.
    189 * Code optimization and many other improvements.
    190 
    191 = 1.5.5 =
    192 * Bug Fix - Screen options were not saving settings
    193 
    194 = 1.5.4 =
    195 * Using WP inbuilt text editor to edit info window text.
    196 * Increase Info Window Text length to 1000 chars
    197 * Added Screen Option, let user disable text editor
    198 * Load Map's js after other js code. Map's js has lowest (100) priority by default.
    199   User can disable this behaviour. Read FAQ for more.
    200 * Options Page Slug Changed
    201 
    202 = 1.5.3 =
    203 * Bug fix - link to 'readme.txt' was causing malfunction on plugin list page.
    204 * Few more adjustments
    205 
    206 = 1.5.2 =
    207 * Option page re-styled.
    208 * Added Help Menu on top of option page.
    209 * Removed Map Height Unit Option, Height will be in px always.
    210 * Bug fix in marker color option.
    211 * Options to disable css-fixes. (Read FAQ).
    212 
    213 = 1.5.1 =
    214 * Prevent form submission when user press Enter in auto complete
    215 * Screenshot moved to assets, reduce package size
    216 * More FAQ
    217 
    218 = 1.5 =
    219 * First release on WordPress Plugin Directory
    220 * Add Search by Address (Auto complete)
    221 * Add Marker Color option
    222 
    223 = 1.4 =
    224 * Fix controls appears incorrectly in certain conditions (css fixes)
    225 * Code clean up
    226 
    227 = 1.3 =
    228 * Added notes about flushing cache
    229 * Load Color API only on Option page
    230 * Special checks for Color API
    231 
    232 = 1.2 =
    233 * Fix Bugs
    234 
    235 = 1.1 =
    236 * Fix Bugs
    237 * Sanitize Inputs
    238 * Allow HTML in info window
    239 
    240 = 1.0 =
    241 * First public beta
    242 
    243 
    244 
    245 == Arbitrary section ==
    246 Nothing in this section, Read FAQ.
     290* More stable and secure
     291* Tested with WordPress v4.2
     292
     293= 0.2 =
     294* Updated docs and adjustments
     295* Submitted to WordPress plugin directory
     296
     297= 0.1 =
     298* First beta
     299
     300
     301
     302== Other Notes ==
     303
     304You should be running minimum of v0.9.0 of this plugin.
Note: See TracChangeset for help on using the changeset viewer.