// See bellow for the description of the fields

//    /cache/json/cache.json, the cache.json of the index of the gallery:
{
  "dirs":[{"ID":0, "url":"directoryX", "thumbs":['picX_m.jpg'], "descr":"dir descr", starred:false}],
}

//    /cache/json/directoryX/cache.json, the cache.json of directoryX:
{
  "dirs":[],
  "pics":[{"url":"picX.jpg", "original":true}],
  "vids":[{"url":["vid.mp4", "vid.ogv"]}, {"url":["vid2.ogv"]}],
  "gpx":["pics/directoryX/mygpx.gpx"],
  "gpxtype":"terrain",
  "descr":"dir descr",
}

// Format description
// All variables named foo* may be undefined
{
  dirs*:[                                                              // list of subdirectories
    {
       ID:<display order>,                                             // e.g., 0 
       url:<name of the directory>,                                    // e.g., 'subdirdirX' 
       thumbs:[<name of thumbs>],                                      // e.g., ['index_m.jpg', '0_m.jpg'] 
                                                                       // You can replace _m with _c or _b in your code 
                                                                       // to access thumbnails of different size 
       descr:<description>,                                            // e.g., 'foobar' 
       starred:<true if the directory should be highlighted>,  
    }
  ],
  pics*:[                                                              // list of pictures
    {
       url:<name of the picture>,                                      // e.g., foo.jpg
       fullpath*:<path of the picture (if undefined, path=path of the gallery)> 
       original:true if the original picture is bigger than the _r thumbnail
    }
  ],
  vids*:[                                                              // list of videos
    {
      url:[<nameS of the video>]                                       // e.g., [foo.mp4, foo.ogv]
    }                                                                  // /!\ videos with same basename but different
                                                                       // extensions are regrouped!
  ],
  gpx*:[<PATH of the gpx files of the gallery>] or [],
  gpxtype*:<map type, e.g., "terrain", "satellite" or "roadmap">
  descr*:<description of the gallery>
}

              

/*
 * Do not forget to activate the plugin in the administration before testing!
 * Then update a directory that contains a .hello file and go into the gallery. It will show an alert box.
 * WARNING: the name of the class is important! Make sure that if your plugin is in pages/myplugin/, then the class is named Pages_Myplugin_Index!
 */
class Pages_Myplugin_Index {
   public static $description = "Plugin";
   public static $isOptional = true;
   public static $showOnMenu = false;

   public static $userContentName = "hello";   // The name of what I will show
                                               // Will call showContent('hello', json) in the gallery
   public static $userContentDefaultPosition = 1; // the gallery shows elements in this order by default:
                                                  // galeries, pictures, videos. Insert at position 1 to show 
                                                  // galeries, hello, pictures and videos.

    /* Export one function to the gallery. 
    * Note that we could have put the code in a file and used the getUserScript function
    * to make the gallery load the file (recommended if you have a lot of code to load),
    *  see 2nd example
    */
   static public function getUserFunctions() {
       return array(
          'config.contentPlugins["hello"] = function(json) {
               if(json.hashello) // written by the writeJSON function
                  alert("There is an hello file in this gallery!");
           }'
       );
   }

   /* Called when the gallery writes a JSON. Add our field. */
   public static function writeJSON($args) {
      $json = &$args['json']; 

      $old_json = $args['old_json'];
      $files = $old_json->masterDirectory->getFiles();
      foreach($files as $f) {
         if($f->extension == 'hello') {
            $json['hashello'] = true;
         }
      }
   }
};
            

/*
 * Do not forget to activate the plugin in the administration before testing!
 * WARNING: the name of the class is important! Make sure that if your plugin is in pages/myplugin/, then the class is named Pages_Myplugin_Index!
 */
class Pages_Myplugin_Index {
   public static $description = "Plugin";
   public static $isOptional = true;
   public static $showOnMenu = false;
   public static $userContentName = "hello";   
   public static $userContentDefaultPosition = 1; 

   /*
    * We export a tpl file in the main administration page.
    * The tpl will be filled by the index.myplugin.js file.
    */
   static public function getTpl() {
      $template = new liteTemplate();
      $template->file('pages/myplugin/tpl/index.tpl');
      return $template->returnTpl();
   }

   // this will be exported in the gallery.
   static public function getUserFunctions() {
       return array(
          'config.contentPlugins["hello"] = function(json) {
               if(json.hashello) // written by the writeJSON function
                  alert("You wrote "+json.hashello+" in the administration");
           }'
       );
   }

   public static function writeJSON($args) {
      $json = &$args['json']; 
      $old_json = $args['old_json'];
      $old_content = $old_json->get();

      // only write something in the json for the directory that is being updated
      if($old_json->masterDirectory->isUpdated) {
         if(isset($old_content['hashello'])
            $json['hashello'] = $old_content['hashello'];
         return;
      }

      // here we set the json.hashello field if something has been written in the text input of our plugin of the directory that is being updated
      // see main.js file to see where myplugin_post_var is set.
      if(Controller::getParameter('myplugin_post_var', null))
         $json['hashello'] =  Controller::getParameter('myplugin_post_var', null);
   }
};
            

<script id="myplugTpl" type="text/x-jquery-tmpl">
   <tr style="height:40px">
      <td class="translate">myplu</td>
      <td width="100%">
        <input type="text" id='plug_${id}' type="input" value="${hello}" />
      </td>
   </tr>
</script>
            

var MyPlugin = {
   //called before writing the json of directory 'dir'
   //id is the unique id that is passed to your plugin template file; 
   //it can be used to retrieve values of inputs (or other DOM elements) of the template. See next function.
   //cb is a callback that MUST be called once we are done.
   preWriteJson:function(id, dir, cb) {
      cb(); // we do nothing here
   },

   // called when writing the json. Put any parameter that you want to be sent to PHP.
   getJsonParams:function(id, dir) {
      return { myplugin_post_var:$('#plug_'+id).val() }; // add the value of our input field
   },

   // the json has been written. Nothing else remains to be done
   postWriteJson:function(id, dir, cb) {
      cb();
   },

   // the template has been added. Now you can configure what happens when 
   // the administrator interacts with your buttons/inputs
   addButtonActions:function(id, dir, data) {
      //nothing
   },

   // the gallery provides an utility function that watches changes of content
   // on inputs and checkboxes. When the content changes, the directory theme changes
   // (a warning sign that informs the administrator that she must validate her changes
   // is added for example). In this function you can specify the DOM elements that 
   // should be watched.
   getHooks:function(dir, id) {
      return [$('#plug_'+id)];
   },

   // return what you want to show in the box of a directory that has not been added
   // to the gallery
   getUnparsedDirTpl:function(dir, div, id) {
      var tpl = $("#myplugTpl").tmpl({id:id});
      return tpl.html();
   },

   // return what you want to show in the box of a directory that has been added
   // to the gallery
   getParsedDirTpl:function(dir, id, json) {
      // we reuse the json.hashello field that has been set by PHP when the
      // directory was first added
      return $("#myplugTpl").tmpl({id:id,hello:json.hashello}).html();
   },
};
plugins.push(MyPlugin);
            

known_sentences.concat({
   'myplu' : 'My Plugin:',
});
            

known_sentences.concat({
   'myplugin_activated' : 'Activate my Plugin:',
});
            

$(document).ready(function() {
   var nclicks = 0;
   $('#hello').click(function() {
      var batch = new Batch(ParallelBatch, function(data) {
         // All actions in the batch have completed
         // In this example we only launch one action (foo_bar) but you may want to launch multiple actions
         // and get notified when they have all complete.
         // Notice the 'ParallelBatch' that will launch multiple actions in parallel (4 by default). Use
         // SequentialBatch for actions that must be executed sequentially (e.g., multiple actions touching the same file)
         // Note: Sequential and Parallel Batchs operate on a global level, i.e.,
         // var batch1 = new Batch(SequentialBatch);
         // var batch2 = new Batch(SequentialBatch);
         // ...
         // batch1.launch();
         // batch2.launch(); // will only execute once batch1 has completed its action(s).
      }, null);
      batch.get({action:'myplugin.foo_bar', clicks:++nclicks}, function(data) {
         // will call /pages/myplugin/index.php?action=foo_bar&clicks=nclicks&custom_security_variables
         // that will automatically execute the fooBarAction() function of the index.php file
         $('#res').append(data.foo);
      });
      batch.launch(); // Always call that after adding an action to a batch
   });
});
            

<div id="hello">{$CLICK}</div>
<div id="res"></div>
            

 /* WARNING: the name of the class is important! Make sure that if your plugin is in pages/myplugin/, then the class is named Pages_Myplugin_Index! */
class Pages_Myplugin_Index {
   /* Description that will show up in the top menu and in the options; keep it short */
   public static $description = "Hello World";

   /* Can the plugin be deactivated? Should be true */ 
   public static $isOptional = true;

   /* Create a button on the top menu? True only if you want to display something in the administration */
   public static $showOnMenu = true;

   /* 
    * Function called before calling any of the plugin action
    */
   public static function setupAutoload() {
   }

   /* 
    * Function called by the administration options plugin
    * We have no option (see gpx plugin for an example of options)
    */
   static public function getOptions() {
      return array();
   }

   static public function mainAction() {
      $template = new liteTemplate();
      $template->showPage('index'); // Will show ./tpl/index.tpl
      $template->assign(array('CLICK' => 'Click me !'));
      $template->view();
   }

   static public function fooBarAction() {
      $clicks = Controller::getParameter('clicks');
      echo File_JSON::myjson_encode(array(
         "foo" => "Hello! You have clicked the link $clicks times!"
      ));
   }
};
            

 /* WARNING: the name of the class is important! Make sure that if your plugin is in pages/myplugin/, then the class is named Pages_Myplugin_Index! */
class Pages_Myplugin_Index {
   public static $description = "Hello World";
   public static $isOptional = true;
   public static $showOnMenu = false; // do not show up in the administration

   /* 
    * Function called by the administration options plugin
    * We have no option (see gpx plugin for an example of options)
    */
   static public function getOptions() {
      return array();
   }

   /*
    * When the plugin is activated, the following file(s) will be loaded in the gallery
    */
   static public function getUserScripts() {
      return array('./admin/pages/myplugin/scripts/jgallery.myplugin.js');
   }
}; 
            

/*
 * jgallery.myplugin.js
 */
var MyPlugin = {
   // Called on each page change. 
   // Ask the plugin if it wants to handle the current page
   want:function(action) {
      return action == "myplugin"; // only handle #!myplugin
   }

   // we said we wanted the page, now let's handle it!
   handle:function(action) {
      alert("Your are on page "+action); 
   },

   // do various initialization routines and register the plugin
   init:function() {
      jGallery.plugins.push(MyPlugin);
   }
};
// inform the gallery that the file is loaded
config.pluginsInstances.push(FacePlugin);

/* option_en.js This file will be used by the option */
known_sentences.concat({
   'Hello World':'Hello World plugin',
   'my_option':'My option',
};
         

/* option_fr.js This file will be used by the option */
known_sentences.concat({
   'Hello World':'Plugin Hello World',
   'my_option':'Mon option',
};
         

/* en.js This file will be used by your scripts */
known_sentences.concat({
   't1':'Translation 1',
   't2':'{0} done / {1} total',
   't3':function(args) {
      return 'Translation 3: ' + args[0];
   },
};

/* fr.js This file will be used by your scripts */
known_sentences.concat({
   't1':'Traduction 1',
   't2':'{0} fait / {1}',
   't3':function(args) {
      return 'Traduction 3: ' + args[0];
   },
};

         

// Elements with a class="translate" will be translated automatically after the page load.
// However if you add elements later on (e.g., after receiving an AJAX response), you must
// inform the gallery that it must perform new translations. This can be done in a single line:
$(".translate").translate();

// If you want to use arguments in your translations, you have to put the translated text directly
// in your templates as follows:
$("...").append(... + t('t2', [ 0, 1 ]);
$("...").append(... + t('t3', [ 0, 1, 2, 3, ... ]);