From 8327e05c4818cea6969bf931511d9786e18f955a Mon Sep 17 00:00:00 2001 From: Kifah Meeran Date: Sun, 29 Jan 2017 16:49:58 +0400 Subject: [PATCH] README update --- README.txt | 111 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 109 insertions(+), 2 deletions(-) diff --git a/README.txt b/README.txt index ef1473b..5fc6a34 100644 --- a/README.txt +++ b/README.txt @@ -3,9 +3,116 @@ CONTENTS OF THIS FILE * Introduction * Requirements - * Recommended modules * Installation * Configuration * Troubleshooting - * FAQ * Maintainers + + +INTRODUCTION +------------ + +This is a lightweight mobile detection based on the Mobile_Detect.php library, +which can be obtained from the GitHub repository.This module is intended to aid +developers utilizing mobile-first and responsive design techniques who also +have a need for slight changes for mobile and tablet users. An example would be +showing (or hiding) a block or content pane to a particular device. + + * For a full description of the module, visit the project page: + https://drupal.org/project/mobile_detect + + * To submit bug reports and feature suggestions, or to track changes: + https://drupal.org/project/issues/mobile_detect + + +REQUIREMENTS +------------ + + * As noted, this module does not include the actual Mobile_Detect library. + This should be downloaded or cloned from one of the links above and + placed in: + + sites/all/libraries/Mobile_Detect + or somewhere the Libraries API (if present) can find it, eg + + sites/default/libraries/Mobile_Detect + sites/example.com/libraries/Mobile_Detect + + +INSTALLATION +------------ + + * Install as you would normally install a contributed Drupal module. See: + https://www.drupal.org/docs/8/extending-drupal-8/installing-modules + for further information. + + * Once the module is installed and enabled, browse to the Status Report + page (admin/reports/status) and confirm that the library is found. The PHP + file should have a pathname that is similar to + sites/all/libraries/Mobile_Detect/Mobile_Detect.php If you think everything + is installed correctly, you may need to clear the Drupal caches + (admin/config/development/performance). For testing purposes, the demo.php + and unit tests included with the library can be deployed, but these should + not exist on a live production server. + + +CONFIGURATION +------------- + + * The base module just provides a factory method for creating a singleton of + the mobile detection class, for use in themes and other modules: + + $detect = mobile_detect_get_object(); + $is_mobile = $detect->isMobile(); + $is_tablet = $detect->isTablet(); + + See the documentation for the Mobile_Detect library for more information. + + The base module also provides two blocks and a permission that you can add + to your site to output the results from the various tests the class provides. + + * A sub-module is included for integration with ctools. Once enabled, a + "Mobile Detect: device type" will show up in the list of selection and access + rules. When this is used, the list of device types is dynamically built from + the rules present in the Mobile_Detect library, and you can use any + combination of AND/OR/NOT logic that you need. + + Note that the Mobile_Detect considers tablet devices as also being mobile + devices. When you have both tablet and mobile device selection in use, it is + best to place the tablet rules first. For example, when using with for Panel + page selection rules, place the Table variant before the Mobile variant. + + * Experimental support is provided for working with the Drupal page cache. To + use this, enable the mobile_detect_caching module. And then add + + $conf['cache_backends'][] = 'sites/all/modules/mobile_detect/mobile_detect_ +caching/mobile_detect_caching.inc'; + $conf['cache_class_cache_page'] = 'MobileDetectCache'; + $conf['mobile_detect_library'] = 'sites/all/libraries/Mobile_Detect/ +Mobile_Detect.php'; + To your settings.php file. You may need to adjust the path if you installed + the module in a different location. + + Problems should be reported on https://www.drupal.org/node/1889824 + + +TROUBLESHOOTING +--------------- + + * Problems with the actual Mobile_Detect library should be directed to the + GitHub issue queue. + + * Problems with this module and sub-modules should be directed to the Drupal + issue queue for this project. + + +MAINTAINERS +----------- + +Current maintainers: + * Darryl Norris (darol100) - https://www.drupal.org/u/darol100 + * Matthew Donadio (mpdonadio) - https://www.drupal.org/u/mpdonadio + * Sora_tm - https://www.drupal.org/u/sora_tm + * Viktor Vilyus (VVVi) - https://www.drupal.org/u/vvvi + * Matt Chapman (chapabu) - https://www.drupal.org/u/chapabu + -- 2.9.3