Skip to content
This repository has been archived by the owner on Mar 18, 2020. It is now read-only.

Latest commit

 

History

History
130 lines (93 loc) · 6.63 KB

README.md

File metadata and controls

130 lines (93 loc) · 6.63 KB
Raw

Google+ Badge - Particle for Gantry

IMPORTANT: The Particle is deprecated as the Google+ services are no longer running.

This project contains a Gantry Particle and adds the Google+ Badge API functionality to the Gantry templating framework. Google+ Badge encapsulates the parameterization of the Google+ service within a Gantry Particle. Furthermore, it provides an easy, user friendly and GUI assisted configuration and integration. In the current revision the following CMSs are supported:

  • Joomla
  • Wordpress
  • Grav

Prerequisites

  • CMS (Joomla, Wordpress, Grav)
  • Gantry Templating Framework and Theme
  • Google+ Platform API

Download

Choose the correct download for your target platform. The Joomla Plugin System is supported for all Gantry themes globally or locally for the templates Helium and Hydrogen. The latest Particle version is v1.3.3.

Attention: When migrating from v1.1.2 to v1.2.0 or higher the existing settings of the particle will be reset.

Default Particle: English / Italian / German

Legacy Particle - Gantry <5.3.2: English / Italian / German

Joomla Plugin - All Templates (Global): English / Italian / German

Joomla Plugin - Hydrogen: English / Italian / German

Joomla Plugin - Helium: English / Italian / German

Automatic Installation (Joomla only)

  1. Download the Plugin of the Google+ Badge Particle for Hydrogen, Helium or Global installation.
  2. Install it over the Joomla Plugin System.

If you install the plugin globally be aware that the resource location changes to /media/gantry5/engines/nucleus

Manual Installation

  1. Download the Default or Legacy Package of the Google+ Badge Particle. If you are using Gantry <5.3.2 please use the Legacy Package for compatibility reasons.
  2. Extract the files.
  3. Copy the .html.twig and the .yaml file to your particle folder /[GANTRY_THEME]/custom/particles. Please check the listing below to determine where the template folder for your CMS is located.
  4. [Optional] Copy the .js file to the folder /[GANTRY_THEME]/custom/js. Create the folder if it does not exist.

CMS Template Folder

Please be aware that the template folder path varies in dependence of the used CMS. Here is a list of the folders for the different platforms:

Wordpress

/wp-content/themes/[GANTRY_THEME]

Joomla

/templates/[GANTRY_THEME]

Grav

/user/data/gantry5/themes/[GANTRY_THEME]

Configuration

  1. Go to your Gantry templating backend (e.g. Extensions/Templates).
  2. Switch to Layout and add the new appearing Particle called Google+ Badge either globally to your site (base outline), to a specific template or page by dragging it to the designated section.
  3. Configure the appearance according to your favor.
  4. [Optional] The download package contains the original version of the Google+ Badge API JS file. You can embed it over the backend configuration if you do not want to use the default CDN. If you chose automatic installation the file is already there.

Supported Parameters and Particle Options

  • Custom CSS classes
  • Site types
    • Profile, Page and Community
  • Theme
    • Light and dark
  • Orientation
    • Landscape and portrait
  • Badge language (~60)
  • Sizing of badge
  • Photo for badge
  • Badge description
  • Community owner
  • Loading mechanism
  • JS priority and placement (head or footer)
  • JS loading
    • Remote, Local and Default
  • JS execution
    • Asynchronous
    • Deferred

Showroom

Insight of the Google+ Badge - Gantry Particle configuration:

Backend (1) - Appearance

1

Backend (2) - JS

2

Examples for the different supported Google+ Badges:

Frontend (1) - Profile

3

Frontend (2) - Page

4

Frontend (3) - Community

5

Future Tasks

  • add more languages

Known Issues

None

Dependencies

Google+ Badge API

Gantry Framework

Credits

Thanks to the Gantry team for providing a modern templating framework.

Thanks to Google for the Google+ Badge API.

Thanks to mariantanase from tanase.it for the inspiration as well as the Italian back- and frontend translation.

by thex, mariantanase | gantryprojects

Copyright (c) 2018, free to use in personal and commercial software as per the license.