Documentation

There are few simple steps to follow.

  • You would start by installing the module which you would then activate.
  • Once this is done you would modify or create few pages where Ziggeo embeddings would be presented

All of this is explained in detail in the sections bellow.

To install the module you should:

  1. As per Drupal recommendations, put your website into maintenance mode
  2. Install the "Libraries API" module (if you do not have it installed already);
  3. download the Ziggeo PHP SDK from our GitHub repository to your website
  1. The downloaded SDK zip file should be unpacted/unziped and placed into /sites/all/libraries/ folder on your server.
  • Make sure the path to the Ziggeo.php file becomes: sites/all/libraries/ZiggeoPhpSdk/Ziggeo.php.
  1. (ONLY APPLIES IF YOU ARE UPDATING) Delete the files in your current Ziggeo module folder
  2. Download the new module files from Drupal project page and place them in the (now) empty Ziggeo module folder
  • if you are installing the module, you would need to create "Ziggeo" folder
  • (this will usually be "sites/all/modules/").
  • Please don't install your module in Drupal core's "modules" folder, since that will cause problems as is bad practice in general and as such if "sites/all/modules" doesn't exist yet, just create it.
  1. Run update.php file in your Drupal, or do Flush Cache from the same.
  2. If your website is still in maintenance mode, place it as live.

Once you do this, you should be good to go and Ziggeo module should be ready.

On your Drupal site:

  1. Click on "Modules" menu at the top of the screen - in the "admin" menu.
  2. In the new screen that opens, find the section "Fields" and under it you should see "Ziggeo" - check it.
  3. Click on the Save Configuration button to activate it.
  4. You should see the notification about the configuration being saved properly: "The configuration options have been saved."
  1. Click on "Structure" menu at the top of the screen.
  2. Click on "Content types".
  3. Here you can add Ziggeo to existing content types or to add new content type that would have Ziggeo within it only. For most setups, we will describe adding it to existing and default ("article" and "page") content types.
  4. Click on "manage fields" option under OPERATIONS section.
  5. To add new field, you should add its name in the textbox under "Add new field" label.
  6. Now select the "Ziggeo Field" field on the right under FIELD TYPE section. (* In the WIDGET section you will right away see "Ziggeo Recorder" being selected)
  7. Click on the "Save" button.
  8. You will now be asked for Application Token, Private Key and Encryption Key which you can get from the Overview page of your application within your Ziggeo account, and once you add it, click on "Save field settings".
  • Once you finish adding the field to content type, you will be presented a new page where you can make some modifications.
  • Widget type allows you to set if the embedding will be recorder, uploader or both recorder and uploader (default).
  • If you have any changes that you wish to make, make them and then remember to click on "Save Settings" button at the bottom.
  1. Click on "Structure" menu at the top of the screen.
  2. Click on "Content types".
  3. Click on "manage display" of the same content type that you had added Ziggeo field to.
  4. Find the Ziggeo field.
  5. Once you have done the changes you wanted, be sure to click on "Save" button at the bottom.
  1. Go to "Content" menu.
  2. Click on the "Add content" sub menu.
  3. Now click on the type of the page that you had added Ziggeo field to.
  4. Create your page and save it.