Plugin Directory

Changeset 1288632


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

fix wrong readme file 1.7.0

Location:
ank-google-map/trunk
Files:
2 added
1 edited

Legend:

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

    r1288625 r1288632  
    1 === Ank Simplified Google Analytics ===
    2 Tags: google analytics, tracking, light weight, simple, easy, free , multisite, webmaster
     1=== Ank Google Map ===
     2Tags: google map, responsive, light weight, ank, free, easy map
    33Requires at least: 3.8.0
    44Tested up to: 4.3.1
    5 Stable tag: 0.9.9
    6 License: GPLv2
     5Stable tag: 1.7.0
     6License: GPLv2 or later
    77License URI: http://www.gnu.org/licenses/gpl-2.0.html
    88Contributors: ank91
    99
    10 The most simplified Google Analytics Plugin for WordPress.
     10Simple and non-bloated WordPress Google Map Plugin.
    1111
    1212== Description ==
    13 
    14 Track 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 
     13One Website , One Map , One Marker.
     14Simple and non-bloated WordPress Google Map Plugin.
     15Written 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
    8029
    8130== Installation ==
    82 0. Remove existing Google Analytics plugin or disable them.
    83 1. Search for 'Ank Simplified GA' in WordPress Plugin Directory and Download the .zip file & extract it.
    84 2. Upload the folder `ank-simplified-ga` to the `/wp-content/plugins/` directory
     311. Search for 'ank google map' in WordPress Plugin Directory and Download the .zip file & extract it.
     322. Upload the folder `ank-google-map` to the `/wp-content/plugins/` directory
    85333. Activate the plugin through the 'Plugins List' page in WordPress Admin Area.
    86 4. Configure this plugin via Settings-->Google Analytics
    87 5. Login to Google Analytics account to view stats.
     344. Configure this plugin via Settings-->Ank Google Map
     355. Paste the `[ank_google_map]` short-code in your pages/posts/widgets.
    8836
    8937
    9038== Frequently Asked Questions ==
    9139
    92 
    93 = What is different with this plugin ? =
    94 
    95 WordPress plugin directory already filled with many of these kind of plugins.
    96 But not all are optimized for performance.
    97 Most of them lacks some features, while some of them cover unused features.
    98 
    99 This plugin was developed to provide most used feature in one place without compromising the speed.
    100 So 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 
    105 There 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 
     40= Why did you call it Light Weight ? =
     41
     42Because it does not depend on jQuery, written in pure Java Script.
     43Options page utilize inbuilt jQuery and Color Picker.
     44It uses inbuilt WP dash-icons in Plugin Options Page.
     45It uses inbuilt WP text editor on Plugin Options Page.
     46It does not create additional tables in your database, uses inbuilt 'wp_options' table.
     47The whole package is about 60 kb. (~15 kb zipped).
     48
     49= What do you mean by Non Bloated =
     50
     51There are many of Map plugins in plugin directory, but most of them not written well.
     52Means they put lots of java script (uncompressed) code on every page of your website.
     53They also loads jquery file before them which effects your page speed.
     54This plugin will enqueue its js files on the required page only.
     55It 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 controls does not shown correctly on front-end =
     62
     63Add 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
     71Add this line to your theme's functions.php
     72`add_filter( 'widget_text', 'do_shortcode' );`
    11273
    11374= Changes does not reflect after saving settings ? =
    11475
    115 Are you using some Cache/Performance plugin (eg: WP Super Cache/W3 Total Cache) ?
    116 
    117 Then flush your WP cache after saving settings.
     76Are you using some Cache/Performance plugin (eg:WP Super Cache/W3 Total Cache) ?
     77Then flush your WP cache and refresh target page.
    11878
    11979= Where does it store settings and options ? =
    12080
    121 WP Database->wp-options->asga_options.
    122 
     81WP Database->wp-options->ank_google_map.
    12382Uses a Single Row, stored in array for faster access.
    12483
     84= From where does it loads additional Marker (colored) images ? =
     85
     86Every marker image is loaded from official Google Server.
    12587
    12688= What if i uninstall/remove this plugin? =
    12789
    12890No worry! It will remove its traces from database upon uninstall.
    129 
    130 It will also disable tracking by removing the code from front-end.
    131 
    132 = Where to find my GA Tracking ID ? =
    133 
    134 Just 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 
    142 Debugging mode allows you to troubleshot problems with Google Analytics web tracking.
    143 Once you enable this mode. Open up your site homepage and press F12 to open developer tools,
    144 now switch to console tab to see detailed messages.
    145 
    146 You can read more about troubleshooting [here](https://developers.google.com/analytics/resources/articles/gaTrackingTroubleshooting#gaDebug)
    147 
    148 Don't forget to disable this mode in production.
    149 
    150 This 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 
    154 You need to configure the plugin for each of sub-site individually.
     91You have to remove short-code from your pages by yourself.
     92
     93= How do i enter correct language code ? =
     94
     95You can force google to load a specific language for all visitors.
     96Get latest supported language code list from [here](https://developers.google.com/maps/faq#languagesupport).
     97If 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
     101Set Map Canvas Width to 100 %. Map will auto center upon resize.
     102
     103= I don't want border on map canvas =
     104
     105Leave the color field empty and it will not be applied.
    155106
    156107= Did you test it with old version of WordPress ? =
    157108
    158 I uses latest version WordPress during development.
    159 So i recommend you to upgrade to latest WordPress today.
    160 
    161 
    162 = Is Google Analytics service free. =
    163 
    164 Yes, There is paid version of Google Analytics also.
    165 
    166 Read more [here](https://developers.google.com/analytics/devguides/collection/analyticsjs/limits-quotas).
    167 
    168 
    169 = How do i enter Google Webmaster verification code ? =
    170 
    171 Login to Google Webmaster [console](https://www.google.com/webmasters/tools/home?hl=en), get the verification code from there
    172 
    173 Checkout this [link](http://googlewebmastercentral.blogspot.in/2011/02/linking-google-analytics-to-webmaster.html)
    174 OR
    175 You can search google like 'Linking google analytics to webmaster'
    176 
     109No, 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
     113No, I love it as like you. But I prefer faster websites.
     114
     115
     116= Is Google Map API is free. =
     117
     118Until we break its terms and conditions.
     119Google Map API V3 does not need an API Key.
     120
     121
     122= Failed to load Google Map. Refresh this page and try again. What is this ? =
     123
     124It means 'Google Map API' is not loaded.
     125
     126Possible reasons are -
     127
     128* No internet connection. (Internet is must).
     129* Other plugin's java script conflict. (Try disabling them one by one).
     130* This plugin has a problem/bug. (Report it now).
    177131
    178132
    179133= Future Plans ? =
    180 * OAuth
    181 * More options may be.
    182 
    183 
     134
     135* I18n for Option Page.
     136* Multiple Maps with Multiple Markers.
     137* Multi-site support
     138* Improved upgrade paths.
     139
     140== Upgrade Notice ==
     141
     142No big changes yet in this plugin, so go ahead and upgrade to new version whenever i release.
     143It just a matter of a second. It will cost not more than 15 KB.
    184144
    185145== Screenshots ==
    186 1. General Options
    187 2. Advanced Options
    188 3. Tracking/Monitor Options
    189 4. Control code execution
    190 5. Troubleshooting Options
    191 
    192 
    193 == Upgrade Notice ==
    194 
     1461. Plugin Option Page Screen
    195147
    196148== Changelog ==
    197149
    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
     150= 1.7.0 =
     151* Minimum php requirement : version 5.3.0
     152* Removed top screen options, always load text editor
     153* Removed bloated code, speed improvement
     154
     155= 1.6.3 =
     156* Fix Option page not working due to wrong js url
     157
     158= 1.6.2 =
     159* Tested upto WordPress 4.3.1
     160* Fix links and updated docs
     161
     162= 1.6.1 =
     163* Disable drag on mobile
     164* Disable Mouse wheel zoom
     165
     166= 1.6.0 =
     167* Tested upto wp v4.2.2
    262168* Minor adjustments
    263169
    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 =
    289 * Multi-site support
    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 
    304 You should be running minimum of v0.9.0 of this plugin.
     170= 1.5.9 =
     171* Execution Speed Improvements
     172
     173= 1.5.8 =
     174* Tested upto WP v4.1
     175* Enqueue the minified version of js file to option page.
     176* Miner fixes
     177
     178= 1.5.7 =
     179* Option page has it own separate class  (easy to manage code)
     180* Few More Improvements
     181
     182= 1.5.6 =
     183* Add Plugin version to database for future use.
     184* Java Script Localization for options page.
     185* Store options page JS code to a separate file. (allow browsers to cache this file)
     186* Now we enqueue our main JS file on target page. (allow browsers to cache this file)
     187* JS priority parameter has been removed from short-code.
     188* Code optimization and many other improvements.
     189
     190= 1.5.5 =
     191* Bug Fix - Screen options were not saving settings
     192
     193= 1.5.4 =
     194* Using WP inbuilt text editor to edit info window text.
     195* Increase Info Window Text length to 1000 chars
     196* Added Screen Option, let user disable text editor
     197* Load Map's js after other js code. Map's js has lowest (100) priority by default.
     198  User can disable this behaviour. Read FAQ for more.
     199* Options Page Slug Changed
     200
     201= 1.5.3 =
     202* Bug fix - link to 'readme.txt' was causing malfunction on plugin list page.
     203* Few more adjustments
     204
     205= 1.5.2 =
     206* Option page re-styled.
     207* Added Help Menu on top of option page.
     208* Removed Map Height Unit Option, Height will be in px always.
     209* Bug fix in marker color option.
     210* Options to disable css-fixes. (Read FAQ).
     211
     212= 1.5.1 =
     213* Prevent form submission when user press Enter in auto complete
     214* Screenshot moved to assets, reduce package size
     215* More FAQ
     216
     217= 1.5 =
     218* First release on WordPress Plugin Directory
     219* Add Search by Address (Auto complete)
     220* Add Marker Color option
     221
     222= 1.4 =
     223* Fix controls appears incorrectly in certain conditions (css fixes)
     224* Code clean up
     225
     226= 1.3 =
     227* Added notes about flushing cache
     228* Load Color API only on Option page
     229* Special checks for Color API
     230
     231= 1.2 =
     232* Fix Bugs
     233
     234= 1.1 =
     235* Fix Bugs
     236* Sanitize Inputs
     237* Allow HTML in info window
     238
     239= 1.0 =
     240* First public beta
     241
     242
     243
     244== Arbitrary section ==
     245Nothing in this section, Read FAQ.
Note: See TracChangeset for help on using the changeset viewer.