Facebook, OpenGraph, Card and Google Analytics
OpenGraph and card entries are automatically created for each page using the Resource pagetitle, createdby, publishedon, description and other attributes. To function as intended the SEO-MetaDeclarations call requires Google Analytics ID, fb:app_id and/or fb:admins, :creator, and :site entries to be populated.
Template HEAD SEO-MetaDeclarations CDN-Header site-Header FontAwesome CDN-Shiv BODY Content FOOTER CDN-Footer site-Footer
Using the Package
It is highly suggested to duplicate the provided templates and chunks before use, as any updates to the Package will overwrite existing elements.
@property string cdn The repository to use: bootstrap, maxcdn, cloudflare, local @property string bootstrapVersion The version of bootstrap to load and should match CDN-Header. Defaults to 3.3.4.
Loads Bootstrap and optionally its default template. Use the siteHeader chunk for dedicated templates which require Bootstrap to be loaded first.
@property string cdn The repository to use: bootstrap, maxcdn, cloudflare, local @property string bootstrapVersion The version of bootstrap to load. Defaults to 3.3.4.
Loads html5shiv.min.js and respond.min.js.
@property string cdn The repository to use: bootstrap, maxcdn, cloudflare, local.
Traditional, Facebook, OpenGraph, Card meta entries. Note: requires the page title to be limited to 70 characters and the description to 200 characters. These will be adjusted automatically.
@property string fb_app_idInstructions: https://help.yahoo.com/kb/yahoo-merchant-solutions/facebook-application-sln18861.html
@property string fb_adminsGo to https://graph.facebook.com/YOUR-FACEBOOK-USERNAME The first line should be your id. Instructions: https://help.yahoo.com/kb/yahoo-merchant-solutions/facebook-application-sln18861.html
@property string googleidThe Google Id can be created by adding the site to your Google Analytics account https://www.google.com/analytics Format: UA-11306908-1
@property string site_logoThe file name of the image to be shown in Facebook Posts, Goolge Plus, LinkedIn, etc. The path will always be the site's assets_url/images. Image size should be 200x200 at a minimum.
@property string _creator @usernameof content creator Reference: https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/markup Example: @shawnwilkerson
@property string _site The @usernamethe card should be attributed to. For a company site use a company account (i.g. @SanityLLC), otherwise use the user's account.
@property string _site_logoThe file name of the image to be shown in Tweets. The path will always be the site's assets_url/images
We have chosen to use some of the most popular packages available to MODX Revolution. This is for two purposes, to expedite users new to the platform getting sites from production to live and to provide working examples of each. The following Packages will automatically be downloaded and installed for use with the Template:
- Provides an automated means to load FontAwesome.
- Automatically translates all email addresses displayed or linked on the site.
- Quick Crumbs
- Provides simple bread crumb functionality.
- Provides Navigation, Breadcrumb, and fast access to resource and user information.
- Provides Navigation.
The intention of this respository and subsequent MODX Revolution Package is to provide a single install setup which can be modified on the fly by those indivudals desiring to do so. It is not intended to necessarily have many updates. The only files which should ever be edited are the Bootstrap3 Template, and the siteHeader and siteFooter Chunks.
The author does not intend to release updates every time a subpackage is updated. You are free to update those as necessary.
Facebook, OpenGraph, Card and Google Analytics require the entry of designated attributes to fully benefit from indexing. If a required attribute is not specified the respective line will not be included in the output from SEO-declarations.
The site logo which will be used with OpenGraph and Card must be stored in /assets/images and specified in SEO-MetaDeclarations using the &site_logo and &_site_logo parameters.
The Subsequent package does not require the site to be empty to be used and will not destroy, reset, or otherwise alter preexisting content. It will, however, overwrite itself during updates. Please duplicate components before use.
For specific installation instructions peruse the docs folder.