Plugin Directory

Changeset 1868737


Ignore:
Timestamp:
05/04/2018 02:52:13 PM (8 years ago)
Author:
vsteks
Message:

seperate README info

Location:
gmaps-google-maps-shortcode/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • gmaps-google-maps-shortcode/trunk/README.md

    r1868736 r1868737  
    11# GMaps Google Maps Shortcode
    2 Tags: maps, google
    3 Contributors: vsteks
    4 Requires at least: 4.0.0
    5 Tested up to: 4.9.5
    6 Requires PHP: 7.1
    7 Stable tag: trunk
    8 License: GPLv2
    9 LICENSE URI: http://gnu.org/license/gpl-2.0.html
    102
    113A simple wordpress plugin to insert Google Maps into posts/pages using the javascript API. Can be used to create markers, lines, and arbitrary shapes.
  • gmaps-google-maps-shortcode/trunk/README.txt

    r1868736 r1868737  
    1 # GMaps Google Maps Shortcode
     1== GMaps Google Maps Shortcode ==
    22Tags: maps, google
    33Contributors: vsteks
     
    99LICENSE URI: http://gnu.org/license/gpl-2.0.html
    1010
    11 A simple wordpress plugin to insert Google Maps into posts/pages using the javascript API. Can be used to create markers, lines, and arbitrary shapes.
     11== Installing ==
     12  After installing you need to set the Gmaps API key in Settings -> General.
    1213
    13 Before using this plugin you must set GMaps API Key in google in Settings > General. To your [API Key][google-api-key].
     14== Changelog ==
    1415
    15 # Shortcodes
     16== Frequently Asked Questions ==
    1617
    17 ## gmaps
     18== Upgrade Notice ==
    1819
    19   The main shortcode of this plugin used to insert a map into a page. All other gmaps shortcodes must be nested inside a gmaps shortcode.
    20 
    21 #### Attributes
    22 
    23 ###### id: Optional
    24 
    25  The id to use for the div map element if not given one will be generated.
    26  
    27  Default: None
    28 
    29 ---
    30 
    31 ###### lng: Required
    32 
    33  The Longitude of the center point on the map.
    34 
    35  Default: None
    36 
    37 ---
    38 
    39 ###### lat: Required
    40 
    41  The Latitude of the center point on the map.
    42 
    43  Default: None
    44 
    45 ---
    46 
    47 ###### type: Optional
    48 
    49  The Type of map can be:
    50    - roadmap
    51    - satellite
    52    - terrain
    53    - hybrid
    54  
    55  Default: roadmap
    56 
    57 ---
    58 
    59 ###### zoom: Optional
    60 
    61   The Scale to draw the map too
    62 
    63   Default: 6
    64 
    65 ---
    66 
    67 ###### disable-default-ui: Optional
    68 
    69  Disable all default Ui Elements
    70 
    71  Default: false
    72 
    73 ---
    74 
    75 ###### draggable: Optional
    76 
    77  Whether the map can be Dragged or not
    78 
    79  Default: false
    80 
    81 ---
    82 
    83 ###### streeview-control: Optional
    84  
    85  Whether or not draw the streetview control
    86 
    87  Default: false
    88 
    89  ---
    90 
    91 ###### shortcuts: Optional
    92 
    93  Enable Keyboard shortcuts on the generated map
    94 
    95  Default: true
    96 
    97  ---
    98 
    99 ###### type-control: Optional
    100 
    101  Whether to display the map type control
    102 
    103  Default: true
    104 
    105  ---
    106 
    107 ###### disable-click-zoom: Optional
    108 
    109  Whether to zoom when clicked
    110 
    111  Default: false
    112 
    113  ---
    114 
    115 ###### clickable-icons: Optional
    116 
    117  Allow icons to be clickable.
    118 
    119  Default: true
    120 
    121  ---
    122 
    123 ###### fullscreen-control: Optional
    124 
    125  Enable the fullscreen control.
    126 
    127  Default: false
    128 
    129  ---
    130 
    131 ###### max-zoom: Optional
    132 
    133  The max scale the map can reach.
    134 
    135  Default: 16
    136 
    137  ---
    138 
    139 ###### min-zoom: Optional
    140 
    141  The min scale the map can reach.
    142 
    143  Default: 0
    144 
    145  ---
    146  
    147 ###### pan-control: Optional
    148 
    149  Enable/Disable pan control.
    150 
    151  Default: true
    152 
    153  ---
    154 
    155 ###### rotate-control: Optional
    156 
    157  Enable/Disable the rotate control.
    158 
    159  Default: true
    160 
    161  ---
    162 
    163 ###### scroll-wheel: Optional
    164 
    165  Enable/ Disable scroll wheel zoom.
    166 
    167  Defeault: true
    168 
    169  ---
    170 
    171 ---
    172 
    173 ## gmaps-marker
    174 
    175  Create a Marker object. Must be nested within a gmaps shortcode.
    176 
    177 #### Attributes
    178 ###### id: Optional
    179 
    180  The id to use for this marker, will be automatically generated if not given. If your planning to open a info-window when clicked must be set.
    181 
    182  Default: marker_XXXXX
    183 
    184  ---
    185 
    186 
    187 ###### title: Optional
    188 
    189  The title to display when the mouse hover's over this marker.
    190 
    191  Default: ''
    192 
    193  ---
    194 
    195 ###### opacity: Optional
    196 
    197  The opacity of the marker icon.
    198 
    199  Default: 1.0
    200 
    201  ---
    202 
    203 ###### visible:
    204 
    205  Whether this marker is visible on the map or not.
    206 
    207  Default: true
    208 
    209  ---
    210 
    211 ###### zindex:
    212 
    213  All markers are displayed on the map by order of their zindex, modify this to place markers on top of eachother.
    214 
    215  Default: 0
    216 
    217  ---
    218 
    219 ## gmaps-polygon
    220 
    221   Create a Polygon object. Must be nested within a gmaps shortcode.
    222 
    223 #### Attributes
    224 ###### id: Optional
    225 
    226  The id to use for this element in the map, will be automatically generated if not given.
    227 
    228  Default: polygon_XXXX
    229 
    230  ---
    231 
    232 ###### stroke-color: Optional
    233 
    234  The outline color to use for this polygon.
    235 
    236  Default: black
    237 
    238  ---
    239 
    240 ###### stroke-opacity: Optional
    241 
    242  The opacity of the polygon's outline.
    243 
    244  Default: 1.0
    245 
    246  ---
    247 
    248 ###### stroke-weight: Optional
    249  
    250  The line thickness to draw the outline of this polygon.
    251 
    252  Default: 2
    253 
    254  ---
    255 
    256 ###### clickable: Optional
    257  
    258  Enable/Disable mouse and touch events.
    259 
    260  Default: true
    261 
    262  ---
    263 
    264 ###### zindex: Optional
    265  
    266  Order in witch to render this polygon
    267 
    268  Default: 0
    269 
    270  ---
    271 
    272 ###### editable: Optional
    273 
    274  Enable/disable Whether this polygon can be modified
    275 
    276  Default: false
    277 
    278  ---
    279 
    280 ###### visible: Optional
    281 
    282  Whether this polygon is initally visible.
    283 
    284  Default: true
    285 
    286  ---
    287 
    288 ###### draggable: Optional
    289 
    290  Enable/Disable moving polygon with mouse.
    291 
    292  Default: false
    293 
    294  ---
    295 
    296 ###### geodesic: Optional
    297 
    298  When true, edges of the polygon are interpreted as geodesic and will follow the curvature of the Earth. When false, edges of the polygon are rendered as straight lines in screen space. Note that the shape of a geodesic polygon may appear to change when dragged, as the dimensions are maintained relative to the surface of the earth.
    299 
    300  Default: false
    301 
    302  ---
    303 
    304 ## gmaps-polyline
    305 
    306   Create a Polygon object. Must be nested within a gmaps shortcode.
    307 
    308 
    309 #### Attributes
    310 ###### id: Optional
    311 
    312  The id to use for this polyline, if not given one will be automatically generated.
    313 
    314  Default: polyline_XXXX
    315 
    316 
    317 ###### stroke-color: Optional
    318 
    319  The outline color to use for this polyline.
    320 
    321  Default: black
    322 
    323  ---
    324 
    325 ###### stroke-opacity: Optional
    326 
    327  The opacity of the polyline's outline.
    328 
    329  Default: 1.0
    330 
    331  ---
    332 
    333 ###### stroke-weight: Optional
    334  
    335  The line thickness to draw the outline of this polyline.
    336 
    337  Default: 2
    338 
    339  ---
    340 
    341 ###### clickable: Optional
    342  
    343  Enable/Disable mouse and touch events.
    344 
    345  Default: true
    346 
    347  ---
    348 
    349 ###### zindex: Optional
    350  
    351  Order in witch to render this polyline
    352 
    353  Default: 0
    354 
    355  ---
    356 
    357 ###### editable: Optional
    358 
    359  Enable/disable Whether this polyline can be modified
    360 
    361  Default: false
    362 
    363  ---
    364 
    365 ###### visible: Optional
    366 
    367  Whether this polyline is initally visible.
    368 
    369  Default: true
    370 
    371  ---
    372 
    373 ###### draggable: Optional
    374 
    375  Enable/Disable moving polyline with mouse.
    376 
    377  Default: false
    378 
    379  ---
    380 
    381 ###### geodesic: Optional
    382 
    383  Default: false
    384 
    385  ---
    386 
    387 ## gmaps-info-window
    388   Create a Info Window Object. Must be nested within a gmaps shortcode.
    389 
    390  
    391 
    392 #### Attributes
    393 
    394 ###### marker: Required
    395 
    396   The marker to open this Info Window if clicked.
    397 
    398 # Examples
    399 
    400 ## Basic
    401 Create a map centered around the Eiffel Tower in Paris, France.
    402 
    403 ```
    404 [gmaps lat=48.8584 lng=2.2945]
    405 ```
    406 
    407 ## No UI
    408 Create a map with no Ui Features centered around the Eiffel Tower in Paris, France.
    409 
    410 ```
    411 [gmaps lat=48.8584 lng=2.2945 disable-default-ui=true]
    412 ```
    413 
    414 ## Basic Marker
    415 Create a map with one marker, centered around Angkor Wat, Cambodia.
    416 ```
    417 [gmaps lat=13.4125 lng=103.8670]
    418     [gmaps-marker lat=13.4125 lng=103.8670]
    419 [/gmaps]
    420 ```
    421 
    422 ## Multi Marker
    423 Create a map showing many markers connected by a Polyline.
    424 
    425 ```
    426 [gmaps lat=13.4125 lng=103.8670]
    427     [gmaps-marker lat=13.4125 lng=103.8670]
    428     [gmaps-marker lat=13.0 lng=103]
    429 [/gmaps]
    430 ```
    431 
    432 # Changelog
    433 
    434 # Frequently Asked Questions
    435 
    436 # Upgrade Notice
    437 
    438 # Screenshots
     20== Screenshots ==
    43921![screenshot](screenshot.png)
    44022
Note: See TracChangeset for help on using the changeset viewer.