============
Plugin Usage
============

3D Spherical Gallery WordPress Plugin is an advanced admin backend and authoring tool that enables you to upload, edit, delete the assets and apply configurations without modifying the source files yourself. 
The plugin supports multiple projects, live preview as well as auto generation of css, html and javascripts files. 

Designer Interface
------------------

.. image:: /_static/img/assets_management.jpg
   :width: 800

Menu Bar
---------

* File

  * New Project: 
      Create an empty project

  * New From Examples: 
      Create a new project from example template

  * Open Project: 
      Open a project

  * Save Project: 
      Save current project

  * New Category: 
      Create new category

  * New Items: 
      Upload new items

  * Preview: 
      Preview current project

  * Publish: 
      Publish current project

  * Download: 
      Download current project

* Edit

  * Delete Project
      Delete current project

  * Project Settings
      Open project setting dialog

  * Remove Category
      Remove current category

  * Rename Category
      Rename current category

  * Remove Items
      Remove selected items

  * Remove Sample Items
  

* View

  * Data Editor
      Switch to data editor view

  * Style Editor
      Switch to style editor view

  * Template Editor
      Switch to template editor view

  * Generated Code
      Switch to Generade code view

* Help

  * User Guide
      Open Designer documentation


Icon Bar
---------
Various commands and functions from Menu Bar are available as buttons in Icon bar. Hover each button to see the tooltip showing its functions.
The order of buttons are:

* New Project
* Open Project
* Save Project
* Delete Project
* New Category
* Delete Category
* Upload Items
* Delete Items
* Delete Sample Items
* Preview
* Publish
* Download Zip
* Generate shortcode


Data Editor
------------

.. image:: /_static/img/dataeditor.jpg
   :width: 800

* The Data Editor view is where you can manage gallery data items including uploading, deleting, modifying the item and its metadata. 
  You can also change the item title, descripiton and crop the image in Data Editor.

Style Editor
-------------

.. image:: /_static/img/styleeditor.jpg
   :width: 800

* With Style Editor you can change all the gallery configurations using intuitive dialog panel and user interface widgets.

Template Editor
---------------

.. image:: /_static/img/templateeditor.jpg
   :width: 800

* The Template Editor shows default templates for the main html, javascript and css files. The template uses handlebarjs syntax to pull the dynamic data from Data Editor and Project Settings.

Generated Code
---------------

.. image:: /_static/img/codeeditor.jpg
   :width: 800

* The Generated Code presents the final result from Template Editor combined with current gallery data items and gallery configurations.

Workflow
---------

* Start by uploading gallery images using Data Editor. Add the item title and description, you can also crop the image to a suitable size.
* Switch to Style Editor to apply and adjust any configurations and styles avaiable.
* Hit the Preview button (eye icon) to generate preview files and preview the current gallery. 
* Hit the Publish button to generate the final project files.
* You can also Download the published project as ZIP files for maintenance purpose.
* Hit Generate Shortcode to display and copy the generated shortcode
* Insert the shortcode into Wordpress post or page