-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathREADME.txt
283 lines (228 loc) · 13.4 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
Metatag
-------
This module allows you to automatically provide structured metadata, aka "meta
tags", about your website and web 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, LinkedIn, etc (see
below).
This version of the module only works with Drupal 7.28 and newer.
Features
------------------------------------------------------------------------------
The primary features include:
* The current supported basic meta tags are ABSTRACT, DESCRIPTION, CANONICAL,
GENERATOR, IMAGE_SRC, KEYWORDS, PUBLISHER, REVISIT-AFTER, RIGHTS, ROBOTS,
SHORTLINK and the page's TITLE tag.
* Multi-lingual support using the Entity Translation module.
* Translation support using the Internationalization (i18n) module.
* Full support for entity revisions and workflows based upon revision editing,
e.g., Revisioning module.
* Per-path control over meta tags using the "Metatag: Context" submodule
(requires the Context module).
* Integration with the Views module allowing meta tags to be controlled for
individual Views pages, with each display in the view able to have different
meta tags, by using the "Metatag: Views" submodule.
* Integration with the Panels module allowing meta tags to be controlled for
individual Panels pages, by using the "Metatag: Panels" submodule.
* 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, 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 and fb:admins 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.
* An API allowing for additional meta tags to be added, beyond what is provided
by this module - see metatag.api.php for full details.
* Support for the Migrate module for migrating data from another system - see
metatag.migrate.inc for full details.
* Support for the Feeds module for importing data from external data sources or
file uploads.
* Integrates with Devel_Generate, part of the Devel module, to automatically
generate meta tags for generated nodes, via the Metatag:Devel submodule.
* Integrates with Workbench Moderation (both v1 and v2) allowing meta tags on
nodes to be managed through the workflow process.
* The Transliteration and Imagecache Token modules (see below) are highly
recommended when using image meta tags, e.g. og:image.
* Several advanced options may be controlled via the Advanced Settings page.
Configuration
------------------------------------------------------------------------------
1. On the People Permissions administration page ("Administer >> People
>> Permissions") you need to assign:
- The "Administer meta tags" permission to the roles that are allowed to
access the meta tags admin pages to control the site defaults.
- The "Edit meta tags" permission to the roles that are allowed to change
meta tags on each individual page (node, term, etc).
2. The main administrative page controls the site-wide defaults, both global
settings and defaults per entity (node, term, etc), in addition to those
assigned specifically for the front page:
admin/config/search/metatags
3. Each supported entity object (nodes, terms, users) will have a set of meta
tag fields available for customization on their respective edit page, these
will inherit their values from the defaults assigned in #2 above. Any
values that are not overridden per object will automatically update should
the defaults be updated.
4. As the meta tags are output using Tokens, it may be necessary to customize
the token display for the site's entities (content types, vocabularies,
etc). To do this go to e.g., admin/structure/types/manage/article/display,
in the "Custom Display Settings" section ensure that "Tokens" is checked
(save the form if necessary), then to customize the tokens go to:
admin/structure/types/manage/article/display/token
Internationalization: i18n.module
------------------------------------------------------------------------------
All default configurations may be translated using the Internationalization
(i18n) module. The custom strings that are assigned to e.g., the "Global: Front
page" configuration will show up in the Translate Interface admin page
(admin/config/regional/translate/translate) and may be customized per language.
Fine Tuning
------------------------------------------------------------------------------
All of these may be controlled from the advanced settings page:
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
obvious. Metatag takes over the display of these tags, thus any changes made
to them in Metatag will supercede Drupal's normal output. To hide a tag, all
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.
* It's possible to disable Metatag integration for certain entity types or
bundles using variables. To disable an entity just assigning a variable
'metatag_enable_{$entity_type}' or 'metatag_enable_{$entity_type}__{$bundle}'
the value FALSE, e.g.:
// Disable metatags for file_entity.
$conf['metatag_enable_file'] = FALSE;
// Disable metatags for carousel nodes.
$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), or the "Clear all caches" button on
admin/config/development/performance.
* 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 Advanced Settings page, which will
cause default values to be used should there not be any values assigned for
the current requested language.
Developers
------------------------------------------------------------------------------
Full API documentation is available in metatag.api.php.
To enable Metatag support in custom entities, add 'metatag' => TRUE to either
the entity or bundle definition in hook_entity_info(); see metatag.api.php for
further details and example code.
The meta tags for a given entity object (node, etc) can be obtained as follows:
$metatags = metatags_get_entity_metatags($entity_id, $entity_type, $langcode);
The result will be a nested array of meta tag structures ready for either output
via drupal_render(), or examining to identify the actual text values.
Troubleshooting / Known Issues
------------------------------------------------------------------------------
* Image fields do not output very easily in meta tags, e.g. for og:image,
without use of the Imagecache Token module (see below). This also provides a
way of using an image style to resize the original images first, rather than
requiring visitors download multi-megabyte original images.
* When using custom page template files, e.g., page--front.tpl.php, it is
important to ensure that the following code is present in the template file:
<?php render($page['content']); ?>
or
<?php render($page['content']['metatags']); ?>
Without one of these being present the meta tags will not be displayed.
* Versions of Drupal older than v7.17 were missing necessary functionality for
taxonomy term pages to work correctly.
* Using Metatag with values assigned for the page title and the Page Title
module simultaneously can cause conflicts and unexpected results.
* When customizing the meta tags for user pages, it is strongly recommended to
not use the [current-user] tokens, these pertain to the person *viewing* the
page and not e.g., the person who authored a page.
* Certain browser plugins, e.g., on Chrome, can cause the page title to be
displayed with additional double quotes, e.g., instead of:
<title>The page title | My cool site</title>
it will show:
<title>"The page title | My cool site"</title>
The solution is to remove the browser plugin - the page's actual output is not
affected, it is just a problem in the browser.
* The core RDF module is known to cause validation problems for Open Graph meta
tags output by the Metatag:OpenGraph module. Unless it is actually needed for
the site, it may be worthwhile to disable the RDF module to avoid any
possible problems for the Open Graph integration.
* If the Administration Language (admin_language) module is installed, it is
recommended to disable the "Force language neutral aliases" setting on the
Admin Language settings page, i.e. set the "admin_language_force_neutral"
variable to FALSE. Failing to do so can lead to data loss in Metatag.
Related modules
------------------------------------------------------------------------------
Some modules are available that extend Metatag with additional functionality:
* Imagecache Token
https://www.drupal.org/project/imagecache_token
Provides additional tokens for image fields that can be used in e.g. the
og:image meta tag; ultimately makes it possible to actually use image meta
tags without writing custom code.
* Transliteration
https://drupal.org/project/transliteration
Tidies up filenames for uploaded files, e.g. it can remove commas from
filenames that could otherwise break certain meta tags.
* Domain Meta Tags
https://drupal.org/project/domain_meta
Integrates with the Domain Access module, so each site of a multi-domain
install can separately control their meta tags.
* Select or Other
https://drupal.org/project/select_or_other
Enhances the user experience of the metatag_opengraph submodule by allowing
the creation of custom Open Graph types.
* Node Form Panes
https://drupal.org/project/node_form_panes
Create custom node-edit forms and control the location of the Metatag fields.
* Textimage
https://drupal.org/project/textimage
Supports using Textimage's custom tokens in meta tag fields.
Credits / Contact
------------------------------------------------------------------------------
Currently maintained by Damien McKenna [1] and Dave Reid [2]; all initial
development was by Dave Reid.
Ongoing development is sponsored by Mediacurrent [3] and Palantir.net [4]. All
initial development was sponsored by Acquia [5] and Palantir.net.
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
References
------------------------------------------------------------------------------
1: http://drupal.org/user/108450
2: http://drupal.org/user/53892
3: http://www.mediacurrent.com/
4: http://www.palantir.net/
5: http://www.acquia.com/