Adding metadata to a guide
What's Guide Metadata?
Meta tags appear in the
<HEAD> area of a webpage and contain information that helps search engines find and rank the relevancy of your page. (You can read more about meta tags on the Mozilla Developer Network.)
All LibGuides pages (LibGuides and LibGuides CMS) have some meta tags defined by default, so there's no need to add them here. (Not sure which ones we use? Just view the source code of one of your guides!)
In addition, LibGuides CMS customers can add additional meta tags to their guides, giving them the ability to add their own custom metadata.
What might you do with this additional Guide Metadata area?
- When using the Automagic LTI Tool, guides are matched to courses based upon their metadata. You can add metadata to your guides to ensure they are matched to the appropriate courses.
- Additional tags to improve your guide's search ranking in search engines.
- Add tags specific to your search aggregator (this will work as long as those aggregators are indexing your site by crawling it, and is not currently available via XML export).
Adding & managing metadata while editing a guide
- While editing your guide, click on the Guide Information () button.
- Select Guide Metadata from the dropdown.
- In the Guide Metadata window, click on the Custom Metadata tab.
- To add metadata, locate the row with an ID of Add Record and click on "Empty" in the Name column and enter the name for your metadata. This is what appears in the
<meta>tag's name attribute.
- Click on "Empty" in the Value column and enter the value for your metadata. This is what appears in the
<meta>tag's content attribute.
- To make a metadata value public, select its Public checkbox. Enabling this option will include the
<meta>tag in the
<head>tag of your public guide page. Otherwise, it will only be used internally within LibGuides, such as with the LTI Tool.
Viewing, editing, and deleting metadata
- To view your guide's default metadata, click on the Dublin Core tab.
- This is generated automatically by LibGuides for each guide and cannot be modified.
- To edit an existing metadata name, click on it and enter your changes.
- To edit an existing metadata value, click on it and enter your changes.
- To remove metadata from a guide, click on its Delete button.
- Please note that changes to public metadata may not be reflected in search engines or discovery services until the next time your site is crawled/indexed.
- If you are using an LTI value for the LTI Automagic Tool, please note that this may prevent the guide from matching with related courses.
- Deleting metadata is permanent, but you can always recreate the deleted value if you change your mind later on.
Adding metadata via Admin > Metadata & URLs
Admin users can also add metadata via the Admin > Metadata & URLs settings, individually or via a bulk upload. From there, they can also edit and delete metadata for guides, as well as subjects and e-reserves courses.
- Go to Admin > Metadata & URLs.
- Click on the Metadata tab.
- Click on the Add Metadata button.
- In the Add/Edit Metadata window, select the guide to which to add the metadata.
- The Metadata Name field will automatically be set to the LibGuides Metadata Name value from your Automagic Tool settings.
- In the Metadata Value field, enter the value for this metadata. This will be the value used to match the guide to your LMS course numbers.
- If you would like to include this metadata in a
<meta>tag on the public guide page, set the Public? option to Enabled. Otherwise, leave this set to Disabled.
- When metadata is public, it will be able to be picked up by search engines and other indexing tools.
- You do not need to make this metadata public in order to use it with the LTI tool.
- Click the Save button.