Skip to content

Commit

Permalink
Update index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
@CosmicLaca
CosmicLaca committed Feb 7, 2016
1 parent ff7ad9f commit 2877259
Showing 1 changed file with 54 additions and 68 deletions.
122 changes: 54 additions & 68 deletions doc/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,61 +22,61 @@ You can insert several widgets to your own #mappiamo template. You have to edit
Address
---------

Usage code example:
<?php M_Template::widget('address'); ?>
- Usage code example:
- <?php M_Template::widget('address'); ?>

This widget have no parameters, creating search box for map, the widget centering map for the search address.
The search string must be real name (for example city name) to get real latitude and longitude.

Allmeta box
-------------

Usage code example:
<?php $this->widget('box_allmeta'); ?>
- Usage code example:
- <?php $this->widget('box_allmeta'); ?>

This widget have no parameters, creating list (table) of all meta data of content.
This widget is ideal for right column. The disabled meta names is on the row 13 on the code.

Collabrators box
--------------------

Usage code example:
<?php $this->widget('box_collabrators' array(n)); ?>
- Usage code example:
- <?php $this->widget('box_collabrators' array(n)); ?>

This widget have one parameters "n", what is the maximum number of collabotators article based on the selected content.
The collaborator's e-mail must be saved to the meta value with name "collaborator".

Cookie box
------------

Usage code example:
<?PHP $this->widget('box_cookie'); ?>
- Usage code example:
- <?PHP $this->widget('box_cookie'); ?>

This widget have no parameters, creating alert box for cookie usage.

Distance box
---------------

Usage code example:
<?PHP $this->widget('box_distance'); ?>
- Usage code example:
- <?PHP $this->widget('box_distance'); ?>

This widget have no parameters, creating list (table) of related articles not far from the current content.
The distance is fixed on code, the radius is 1 km.

Events box
-----------

Usage code example:
<?PHP $this->widget('box_events'); ?>
- Usage code example:
- <?PHP $this->widget('box_events'); ?>

This widget have no parameters, creating list (table) of events not far from the current content.
The distance is fixed on code, the radius is 1 km.

Instagram box
----------------

Usage code example:
<?PHP $this->widget('box_instagram', NULL); ?>
- Usage code example:
- <?PHP $this->widget('box_instagram', NULL); ?>

This widget have one parameter what is the hashtag for images.
If this parameter missing or NULL, the default hashtag is 'tourism'.
Expand All @@ -85,52 +85,51 @@ With meta name 'hashtag-instagram' can be overwite the deafult hashtag to anythi
Onemeta box
------------

Usage code example:
<?PHP $this->widget('box_onemeta', '[meta_name]'); ?>
- Usage code example:
- <?PHP $this->widget('box_onemeta', '[meta_name]'); ?>

This widget have one parameter what is the meta name to get the value of only oane meta data.
This widget can be used on the column of main content.

Youtube box
--------------

Usage code example:

<?php $this->widget('box_youtube', array('[developer key]', '[channel id]', [maximum content])); ?>
- Usage code example:
- <?php $this->widget('box_youtube', array('[developer key]', '[channel id]', [maximum content])); ?>

This widget have 3 parameters. Developer key, youtube channel id, and the maximum number of youtube content.
This widget can be inserted to the left column, and creating scrollable carousel of selected channel content.

Allmeta
----------

Usage code example:
<?PHP $this->widget('content_allmeta'); ?>
- Usage code example:
- <?PHP $this->widget('content_allmeta'); ?>

This widget have no parameters, creating list (table) of meta data from the current content.
This widget created for list or table of standard schemantic data if available.

Headline
---------

Usage code example:
<?PHP $this->widget('content_headline'); ?>
- Usage code example:
- <?PHP $this->widget('content_headline'); ?>

This widget have no parameters, creating group of some data and metadata which are rewired on content column between title and content text.

Flickr
--------

Usage code example:
<?PHP $this->widget('flickr'); ?>
- Usage code example:
- <?PHP $this->widget('flickr'); ?>

This widget have no parameters, creating flickr image groups on the map by visible box of map.

Form contact
---------------

Usage code example:
<?PHP $this->widget('form_contact', array('[registered username]')); ?>
- Usage code example:
- <?PHP $this->widget('form_contact', array('[registered username]')); ?>

This widget have one parameter, the parameter must be the username of registered Mappiamo user.
This widget creating form with input fileds for sending simple message with server side validation.
Expand All @@ -144,31 +143,28 @@ The widget fetching gravatar icon by the user's e-mail address, if the user regi
Jplayer
-------

Usage code example:
<?PHP $this->widget('jplayer'); ?>
- Usage code example:
- <?PHP $this->widget('jplayer'); ?>

This widget have no parameters, creating javascript player for audio (or video) content.
The required meta name is 'audio' and the meta value must be the full url of audio or video file.

Video box
-----------

Usage code example:
<?PHP $this->widget('videobox'); ?>
- Usage code example:
- <?PHP $this->widget('videobox'); ?>

This widget have no parameters, creating embedd iframe player for youtube content by full url.
The required meta name is 'videobox' and the meta value must be the full url of youtube video.

Lastcontent
--------------

Usage code examples:

<?php $this->widget('lastcontent', array(5)); ?>

<?php $this->widget('lastcontent', array(5, 'event', 'start', 'from_now')); ?>

<?php $this->widget('lastcontent', array(5, 'post', 'created')); ?>
- Usage code examples:
- <?php $this->widget('lastcontent', array(5)); ?>
- <?php $this->widget('lastcontent', array(5, 'event', 'start', 'from_now')); ?>
- <?php $this->widget('lastcontent', array(5, 'post', 'created')); ?>

This widget have parameters. The first is the maximum number of content, this is required.
All other paramteres are optional: [content type], [ordering column name],
Expand All @@ -177,32 +173,26 @@ and if the content type is 'event', the last parameter 'from_now' shows only cur
Full featured menu
----------

Usage code example:

<?php M_Template::widget('menu_full', array('[category name]', '[treemenu|popmenu]', '09', 'check')); ?>
- Usage code example:
- <?php M_Template::widget('menu_full', array('[category name]', '[treemenu|popmenu]', '09', 'check')); ?>

This widget have parameters. Creating custom menu system by Mappiamo "pages" and "menus", and display
selected categories on the map.

the parameters:
1, The category name

2, Menu type: 'treemenu' or 'popmenu'

3, Template number of menu only. Menus have 15 templates.

4, How menu display the selected catorgory contents:
'link' - the category opens new page with content list
'check' - the category displays as marker on the map
- Parameters:
1) The category name
2) Menu type: 'treemenu' or 'popmenu'
3) Template number of menu only. Menus have 15 templates.
4) How menu display the selected catorgory contents:
- 'link' - the category opens new page with content list
- 'check' - the category displays as marker on the map

Owl image
------------

Usage code example:

<?PHP $this->widget('owl_image', array('category', 4, 60)); ?>

<?PHP $this->widget('owl_image', array('path', 6, 'templates/soccorso/images/partners', 'index.php?module=category&object=59')); ?>
- Usage code example:
- <?PHP $this->widget('owl_image', array('category', 4, 60)); ?>
- <?PHP $this->widget('owl_image', array('path', 6, 'templates/soccorso/images/partners', 'index.php?module=category&object=59')); ?>

This widget have parameters, creating image carousel to the content column.
The source images can get from two different source: 'category' or 'path'. This is the first parameter.
Expand All @@ -215,11 +205,9 @@ will open the document contains clicked image.
Owl video
-------------

Usage code example:

$TubeID = array('jkovdYV0qm0', 'dw6wZQkfsn0', 'CqdSzVXkhmY', 'km3JiaPqWMI', 'NyCwOdyhZco', 'YJTxnhjpF3U', 'HOVYTZkvjH8', '2Tlou1Vdg6Y', '0_rtwI_nUlI', 'LCtp7D0uCjA');

$this->widget('owl_video', array($TubeID, 3));
- Usage code example:
- $TubeID = array('jkovdYV0qm0', 'dw6wZQkfsn0', 'CqdSzVXkhmY', 'km3JiaPqWMI', 'NyCwOdyhZco', 'YJTxnhjpF3U', 'HOVYTZkvjH8', '2Tlou1Vdg6Y', '0_rtwI_nUlI', 'LCtp7D0uCjA');
- $this->widget('owl_video', array($TubeID, 3));

This widget have parameters, creating video carousel to the content column.
The first parameter must be an array, contains all youtube video id required for the carousel.
Expand All @@ -228,19 +216,17 @@ The second parameter is how many videos display at once by the carousel.
Weather
--------

Usage code example:
<?PHP $this->widget('weather'); ?>
- Usage code example:
- <?PHP $this->widget('weather'); ?>

This widget have no parameters, creating weather report on the map.

Disqus
----------

Usage code example:

$Types = array('post', 'event');

<?php M_Template::widget('disqus', array($Types)); ?>
- Usage code example:
- $Types = array('post', 'event');
- <?php M_Template::widget('disqus', array($Types)); ?>

This widget have no parameter as array. Creating comment section on content page.
Disqus account and disqus site name required for preferences. The parameter contains types where the disqus available.

0 comments on commit 2877259

Please sign in to comment.