diff --git a/README.txt b/README.txt index a6a771d..f736d0b 100644 --- a/README.txt +++ b/README.txt @@ -167,8 +167,9 @@ submodule. Fine Tuning ------------------------------------------------------------------------------ -All of these may be controlled from the advanced settings page: -admin/config/search/metatags/settings +* There are many options available on the settings page to control how Metatag + works: + admin/config/search/metatags/settings * It is possible to "disable" the meta tags provided by Drupal core, i.e. "generator", "canonical URL" and "shortlink", though it may not be completely @@ -177,69 +178,29 @@ admin/config/search/metatags/settings that is necessary is to clear the default value for that tag, e.g. on the global settings for nodes, which will result in the tag not being output for those pages. -* By default Metatag will load the global default values for all pages that do - not have meta tags assigned via the normal entity display or via Metatag - Context. This may be disabled by setting the variable 'metatag_load_all_pages' - to FALSE through one of the following methods: - * Use Drush to set the value: - drush vset metatag_load_all_pages FALSE - * Hardcode the value in the site's settings.php file: - $conf['metatag_load_all_pages'] = FALSE; - To re-enable this option simply set the value to TRUE. -* By default users will be able to edit meta tags on forms based on the 'Edit - meta tags' permission. The 'metatag_extended_permissions' variable may be set - to TRUE to give each individual meta tag a separate permission. This allows - fine-tuning of the site's editorial control, and for rarely-used fields to be - hidden from most users. Note: The 'Edit meta tags' permission is still - required otherwise none of the meta tag fields will display at all. The - functionality may be disabled again by either removing the variable or - setting it to FALSE. -* Each entity type (nodes, terms, users, etc) & bundle (content types, - vocabularies, etc) may have its Metatag integration enabled & disabled from - the Settings page. - These UI options correspond to variables. To enable an entity or bundle just - assign a variable 'metatag_enable_{$entity_type}' or - 'metatag_enable_{$entity_type}__{$bundle}' the value FALSE, e.g.: - // Disable metatags for files (file_entity module). - $conf['metatag_enable_file'] = FALSE; - // Disable metatags for carousel nodes, but leave it enabled for all other - // content types. - $conf['metatag_enable_node__carousel'] = FALSE; - To enable the entity and/or bundle simply set the value to TRUE or remove the - settings.php line. Note that the Metatag cache will need to be cleared after - changing these settings, specifically the 'info' records, e.g., 'info:en'; a - quick version of doing this is to clear the site caches using either Drush, - Admin Menu (flush all caches -> Metatag), or the "Clear all caches" button on - admin/config/development/performance. Changing these from the Settings page - automatically clears the cache. -* By default Metatag will not display meta tags on admin pages. To enable meta - tags on admin pages simply set the 'metatag_tag_admin_pages' variable to TRUE - through one of the following methods: - * Use Drush to set the value: - drush vset metatag_tag_admin_pages TRUE - * Hardcode the value in the site's settings.php file: - $conf['metatag_tag_admin_pages'] = TRUE; - To re-enable this option simply set the value to FALSE or delete the - settings.php line. -* When loading an entity with multiple languages for a specific language the - meta tag values saved for that language will be used if they exist, otherwise - values assigned to the entity's default language will be used. This - may be disabled using the enabling the "Don't load entity's default language - values if no languages match" option on the Settings page, which will cause - default values to be used should there not be any values assigned for the - current requested language. + * When using Features to export Metatag configurations, it is suggested to override all of the default configurations and then disable the default configurations via the advanced settings page; doing so will avoid potential conflicts of the same configurations being loaded by both the Metatag module and the new Features-based modules. -* By default all meta tag output for individual entities will be cached in a - separate cache table. This may be disabled by unchecking the "Cache meta tag - output" option on the Settings page, which will cause all meta tags for - entities to be generated uniquely for each page load. Note: the entity - configuration and output for other types of pages will still be cached, but - this can stop the {cache_metatag} table from growing out of control in some - scenarios. + +* Using fields to automatically fill in values for image meta tags is the + recommended way of inserting images - the module will automatically extract + the URL from the value. However, by default this forces social networks, + search engines and certain browsers to download the original version of the + image, which could be multiple megabytes. The alternative is to use the + Imagecache_Token module to instead load meta tags via a specific image style. + As an example, in order to load an image from a node field named + "field_meta_tag_image" using the "seo_thumbnail" style, the following token + would be used: + [node:field_meta_tag_image:seo_thumbnail:uri] + or + [node:field_meta_tag_image:seo_thumbnail] + (They give the same results) + Additionally, dimensions of the image may be obtained from the following: + [node:field_meta_tag_image:seo_thumbnail:width] + [node:field_meta_tag_image:seo_thumbnail:height] Developers @@ -300,6 +261,11 @@ Some modules are available that extend Metatag with additional functionality: Tidies up filenames for uploaded files, e.g. it can remove commas from filenames that could otherwise break certain meta tags. +* Imagecache Token + https://www.drupal.org/project/imagecache_token + Use tokens to load images via image styles, rather than forcing meta tags to + use the original image. + * Alternative hreflang https://www.drupal.org/project/hreflang Output meta tags for diff --git a/metatag.install b/metatag.install index 3671bf5..fcf60c8 100644 --- a/metatag.install +++ b/metatag.install @@ -127,6 +127,17 @@ function metatag_requirements($phase) { ); } + // It's recommended to install the Imagecache Token module to make image + // tokens easier to do. + if (!module_exists('imagecache_token')) { + $requirements['metatag_imagecache_token'] = array( + 'severity' => REQUIREMENT_INFO, + 'title' => 'Metatag', + 'value' => $t('The Imagecache Token module is recommended.'), + 'description' => $t("It is recommended to install the Imagecache Token module to make it easier to control image meta tags, e.g. og:image. See the Metatag module's README.txt for details.", array('@url' => 'https://drupal.org/project/imagecache_token')), + ); + } + // The Admin Language module can cause problems. if (!module_exists('admin_language') && variable_get('admin_language_force_neutral', 0)) { $requirements['metatag_admin_language'] = array(