diff --git a/README.txt b/README.txt index 3b65ef2..765777a 100644 --- a/README.txt +++ b/README.txt @@ -1,17 +1,19 @@ Metatag ------- -This module allows you to automatically provide structured metadata, aka "meta -tags", about your website and web pages. +This module allows a site's builder to automatically provide structured +metadata, aka "meta tags", about the site and individual pages. In the context of search engine optimization, providing an extensive set of -meta tags may help improve your site's & pages' ranking, thus may aid with -achieving a more prominent display of your content within search engine -results. Additionally, using meta tags can help control the summary content -that is used within social networks when visitors link to your site, -particularly the Open Graph submodule for use with Facebook, Pinterest, -LinkedIn, etc (see below). +meta tags may help improve the site's and pages' rankings, thus may aid with +achieving a more prominent display of the content within search engine results. +They can also be used to tailor how content is displayed when shared on social +networks. -This version of the module only works with the v8.0.x releases of Drupal. +For additional information, see the online documentation: + https://www.drupal.org/docs/8/modules/metatag + +This version should work with all Drupal 8 releases, though it is always +recommended to keep Drupal core installations up to date. Requirements @@ -30,12 +32,52 @@ The primary features include: * An administration interface to manage default meta tags. -* Use of standard fields for entity support, allowing for meta tag translations - and revisioning. +* Use of standard fields for entity support, allowing for translation and + revisioning of meta tag values added for individual entities. -* A large volume of meta tags available, covering X basic tags, Y Open Graph - tags, Z Twitter Cards tags, Å Dublin Core tags, ∫ Google+ tags, ç App Links - tags, 8 site verification tags. +* A large volume of meta tags available, covering commonly used tags, Open + Graph tags, Twitter Cards tags, Dublin Core tags, Google+ tags, App Links + tags, site verification tags and more; all but the basic meta tags are kept + in separate submodules. + +* The fifteen Dublin Core Basic Element Set 1.1 meta tags may be added by + enabling the "Metatag: Dublin Core" submodule. + +* The Open Graph Protocol meta tags, as used by Facebook, Pinterest, LinkedIn + and other sites, may be added by enabling the "Metatag: Open Graph" submodule. + +* The Twitter Cards meta tags may be added by enabling the "Metatag: Twitter + Cards" submodule. + +* Certain meta tags used by Google+ may be added by enabling the "Metatag: + Google+" submodule. + +* Facebook's fb:app_id, fb:admins and fb:pages meta tags may be added by + enabling the "Metatag: Facebook" submodule. These are useful for sites which + are using Facebook widgets or are building custom integration with Facebook's + APIs, but they are not needed by most sites and have no bearing on the + Open Graph meta tags. + +* Site verification meta tags can be added, e.g. as used by the Google search + engine to confirm ownership of the site; see the "Metatag: Verification" + submodule. + +* The Metatag: Mobile & UI Adjustments submodule adds the MobileOptimized, + HandheldFriendly, viewport, cleartype, theme-color, format-detection, + apple-mobile-web-app-capable, apple-mobile-web-app-status-bar-style, the + android-app and ios-app alternative link meta tags, and the Android manifest + tag. + +* The hreflang meta tags are available via the Metatag:hreflang submodule. + +* The App Links meta tags may be added by enabling the Metatag: App Links + submodule. + +* Support for meta tags specific to Google Custom Search Appliance are available + in the "Metatag: Google Custom Search Engine (CSE)" submodule. + +* Meta tags specific to Facebook are included in the "Metatag: Facebook" + submodule. * A plugin interface allowing for additional meta tags to be easily added via custom modules. @@ -43,13 +85,6 @@ The primary features include: * Integration with DrupalConsole [1] to provide a quick method of generating new meta tags. -* Site verification meta tags can be added, e.g. as used by the Google search - engine to confirm ownership of the site; see the "Metatag: Verification" - submodule. - -* Certain meta tags used by Google+ may be added by enabling the "Metatag: - Google+" submodule. - Standard usage scenario -------------------------------------------------------------------------------- @@ -58,13 +93,13 @@ Standard usage scenario 3. Adjust global and entity defaults. Fill in reasonable default values for any of the meta tags that need to be customized. Tokens may be used to automatically assign values. -4. You can add bundle defaults by clicking on "Add metatag defaults" and filling - out the form. -5. If you want to adjust metatags for a specific entity, then you need to add - the Metatag field. Follow these steps: +4. Additional bundle defaults may be added by clicking on "Add metatag + defaults" and filling out the form. +5. To adjust metatags for a specific entity, the Metatag field must be added + first. Follow these steps: - 5.1 Go to the "Manage fields" of the bundle where you want the metatag field - to appear. + 5.1 Go to the "Manage fields" of the bundle where the Metatag field is to + appear. 5.2 Select "Meta tags" from the "Add a new field" selector. 5.3 Fill in a label for the field, e.g. "Meta tags", and set an appropriate machine name, e.g. "meta_tags". @@ -144,9 +179,10 @@ Related modules Some modules are available that extend Metatag with additional or complimentary functionality: -* Yoast SEO +* Real-time SEO for Drupal https://www.drupal.org/project/yoast_seo - Adds integration with the Yoast service (https://yoast.com/). + Uses the YoastSEO.js library and service (https://yoast.com/) to provide + realtime feedback on the meta tags. Known issues @@ -167,15 +203,15 @@ Credits / contact -------------------------------------------------------------------------------- Currently maintained by Damien McKenna [2] and Dave Reid [3]. Drupal 7 module originally written by Dave Reid. Drupal 8 port by Damien McKenna and Michelle -Cox [4], and sponsored by Mediacurrent [5], with contributions from Lee Rowlands +Cox [4] and sponsored by Mediacurrent [5], with contributions from Lee Rowlands [6], Rakesh James [7], Ivo Van Geertruyen [8], Michael Kandelaars [9], and many others. -Ongoing development is sponsored by Mediacurrent and Palantir.net [10]. +Ongoing development is sponsored by Mediacurrent and Lullabot [10]. The best way to contact the authors is to submit an issue, be it a support request, a feature request or a bug report, in the project issue queue: - http://drupal.org/project/issues/metatag + https://www.drupal.org/project/issues/metatag References @@ -184,9 +220,9 @@ References 2: https://www.drupal.org/u/damienmckenna 3: https://www.drupal.org/u/dave-reid 4: https://www.drupal.org/u/michelle -5: http://www.mediacurrent.com/ +5: https://www.mediacurrent.com/ 6: https://www.drupal.org/u/larowlan 7: https://www.drupal.org/u/rakesh.gectcr 8: https://www.drupal.org/u/mr.baileys 9: https://www.drupal.org/u/mikeyk -10: http://www.palantir.net/ +10: https://www.lullabot.com/ diff --git a/metatag.module b/metatag.module index 967c728..1c42b85 100644 --- a/metatag.module +++ b/metatag.module @@ -20,12 +20,13 @@ function metatag_help($route_name, RouteMatchInterface $route_match) { // Main module help for the Metatag module. case 'help.page.metatag': $output = '

' . t('About') . '

'; - $output .= '

' . t('This module allows a site to automatically provide structured metadata, aka "meta tags", about the site and individual pages. In the context of search engine optimization, providing an extensive set of meta tags may help improve the site\'s and pages\' rankings, thus may aid with achieving a more prominent display of the content within search engine results. They can also be used to tailor how content is displayed when shared on social networks. For additional information, see the online documentation for Metatag.', [':online' => 'https://www.drupal.org/node/1774342']) . '

'; + $output .= '

' . t('This module allows a site to automatically provide structured metadata, aka "meta tags", about the site and individual pages.'); + $output .= '

' . t('In the context of search engine optimization, providing an extensive set of meta tags may help improve the site\'s and pages\' rankings, thus may aid with achieving a more prominent display of the content within search engine results. They can also be used to tailor how content is displayed when shared on social networks. For additional information, see the online documentation for Metatag.', [':online' => 'https://www.drupal.org/node/1774342']) . '

'; $output .= '

' . t('Intended worflow') . '

'; $output .= '

' . t('The module uses "tokens" to automatically fill in values for different meta tags. Specific values may also be filled in.', [':tokens' => Url::fromRoute('help.page', ['name' => 'token'])->toString()]) . '

'; $output .= '

' . t('The best way of using Metatag is as follows:') . '

'; $output .= '
    '; - $output .= '
  1. ' . t('Customize the global default, fill in the specific values and tokens that every page should have.', [':defaults' => Url::fromRoute('entity.metatag_defaults.edit_form', ['metatag_defaults' => 'global'])->toString()]) . '
    2. '; + $output .= '
  2. ' . t('Customize the global defaults, fill in the specific values and tokens that every page should have.', [':defaults' => Url::fromRoute('entity.metatag_defaults.edit_form', ['metatag_defaults' => 'global'])->toString()]) . '
    3. '; $output .= '
  3. ' . t('Override each of the other defaults, fill in specific values and tokens that each item should have by default. This allows e.g. for all nodes to have different values than taxonomy terms.', [':defaults' => Url::fromRoute('entity.metatag_defaults.collection')->toString()]) . '
    4. '; $output .= '
  4. ' . t('Add more default configurations as necessary for different entity types and entity bundles, e.g. for different content types or different vocabularies.', [':add' => Url::fromRoute('entity.metatag_defaults.add_form')->toString()]) . '
    5. '; $output .= '
  5. ' . t('To override the meta tags for individual entities, e.g. for individual nodes, add the "Metatag" field via the field settings for that entity or bundle type.') . '
    6. ';