Skip to content

Commit

Permalink
Merge pull request #121 from Arkni/patch-doc
Browse files Browse the repository at this point in the history
Improve the documentation
  • Loading branch information
GeLoLabs committed Oct 7, 2014
2 parents 40d3f6f + 2e3e921 commit 2b4db99
Show file tree
Hide file tree
Showing 30 changed files with 42 additions and 43 deletions.
18 changes: 9 additions & 9 deletions Resources/doc/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The complete events configuration is available
Sometimes, you want to use the map & other Google Map related libraries. The bundle provides many integrations but not
all of them. If you need a custom libraries, you can use the following configuration:

```
```yaml
ivory_google_map:
api:
# Your own API helper class
Expand All @@ -85,27 +85,27 @@ javascript.**

This helper allows you to render the html container, javascripts and CSS in a single call.

For twig:
Using twig:

```
{{ google_map(map) }}
```

For php:
Using php:

```
$view['ivory_google_map']->renderMap($map);
```

### Render the HTML container only

For twig:
Using twig:

```
{{ google_map_container(map) }}
```

For php:
Using php:

```
$view['ivory_google_map']->renderHtmlContainer($map);
Expand All @@ -119,13 +119,13 @@ This function renders an html div block with the HTML container ID, the width &

### Render the javascript only

For twig:
Using twig:

```
{{ google_map_js(map) }}
```

For php:
Using php:

```
$view['ivory_google_map']->renderJavascripts($map);
Expand All @@ -148,13 +148,13 @@ after the generated code through extensions. If you want to learn more about tha
Additionally, you can configure some CSS directly on the map. For rendering it, use the twig function :
``google_map_css``.

For twig:
Using twig:

```
{{ google_map_css(map) }}
```

For php:
Using php:

```
$view['ivory_google_map']->renderStylesheets($map);
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/controls/map_type.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.map_type_control`` service is. The configuration
describes below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/controls/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.overview_map_control`` service is. The configuration
describes below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/controls/pan.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.pan_control`` service is. The configuration
describes below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/controls/rotate.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.rotate_control`` service is. The configuration
describes below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/controls/scale.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.scale_control`` service is. The configuration
describes below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/controls/street_view.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.street_view_control`` service is. The configuration
describes below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/controls/zoom.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.zoom_control`` service is. The configuration
describes below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.event`` service is. The configuration describes
below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
4 changes: 2 additions & 2 deletions Resources/doc/usage/layers/kml_layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.kml_layer`` service is. The configuration describes
below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_goole_map:
ivory_google_map:
kml_layer:
# Prefix used for the generation of the KML layer javascript variable
prefix_javascript_variable: "kml_layer_"
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/map.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.map`` service is. The configuration describes
below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
4 changes: 2 additions & 2 deletions Resources/doc/usage/overlays/circle.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.circle`` service is. The configuration describes
below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_goole_map:
ivory_google_map:
circle:
# Your own circle class
class: "My\Fucking\Circle"
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/overlays/encoded_polyline.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.encoded_polyline`` service is. The configuration
describes below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/overlays/ground_overlay.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.ground_overlay`` service is. The configuration
describes below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/overlays/info_window.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.info_window`` service is. The configuration
describes below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
4 changes: 2 additions & 2 deletions Resources/doc/usage/overlays/marker.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.marker`` service is. The configuration describes
below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down Expand Up @@ -53,7 +53,7 @@ $marker = $this->get('ivory_google_map.marker');

If you want to learn more, you can read
[this documentation](https://github.com/egeloen/ivory-google-map/blob/master/doc/usage/overlays/marker.md).
```


### Marker image

Expand Down
3 changes: 1 addition & 2 deletions Resources/doc/usage/overlays/marker_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.marker_cluster`` service is. The configuration
describes below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down Expand Up @@ -44,4 +44,3 @@ $markerCluster = $this->get('ivory_google_map.marker_cluster');

If you want to learn more, you can read
[this documentation](https://github.com/egeloen/ivory-google-map/blob/master/doc/usage/overlays/marker_cluster.md).
```
2 changes: 1 addition & 1 deletion Resources/doc/usage/overlays/marker_image.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.marker_image`` service is. The configuration
describes below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/overlays/marker_shape.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.marker_shape`` service is. The configuration
describes below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/overlays/polygon.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.polygon`` service is. The configuration describes
below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/overlays/polyline.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.polyline`` service is. The configuration describes
below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_google_map
Expand Down
4 changes: 2 additions & 2 deletions Resources/doc/usage/overlays/rectangle.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ By default, the bundle doesn't need any configuration. Most of the service have
you to use the given objects like they are. The ``ivory_google_map.rectangle`` service is. The configuration describes
below is this default configuration.

```
```yaml
# app/config/config.yml

ivory_goole_map:
ivory_google_map:
rectangle:
# Your own rectangle class
class: "My\Fucking\Rectangle"
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/services/business_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
When using a service for business purpose, you will receive a business account from Google. This one allows you to
bypass Google limitation according to your billing plan. To use it, you need to configure it:

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/services/directions/directions.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ you to use the given objects like they are. The ``ivory_google_map.geocoder`` se
configuration describes below is this default configuration but if you don't provide at least one value (for the
`directions` or `directions_request` nodes), the service will not be registered.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ you to use the given objects like they are. The ``ivory_google_map.directions_re
configuration describes below is this default configuration but if you don't provide at least one value (for the
`directions` or `directions_request` nodes), the service will not be registered.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ you to use the given objects like they are. The ``ivory_google_map.distance_matr
configuration describes below is this default configuration but if you don't provide at least one value (for the
`distance_matrix` or `distance_matrix_request` nodes), the service will not be registered.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ you to use the given objects like they are. The ``ivory_google_map.distance_matr
The configuration describes below is this default configuration but if you don't provide at least one value (for the
`distance_matrix` or `distance_matrix_request` nodes), the service will not be registered.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down Expand Up @@ -86,7 +86,6 @@ $request->setTravelMode(TravelMode::DRIVING);
$request->setUnitSystem(UnitSystem::METRIC);
$request->setSensor(false);
```
```

## Process your request

Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/services/geocoding/geocoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ you to use the given objects like they are. The ``ivory_google_map.geocoder`` se
configuration describes below is this default configuration but if you don't provide at least one value (for the
`geocoder` or `geocoder_request` nodes), the service will not be registered.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
2 changes: 1 addition & 1 deletion Resources/doc/usage/services/geocoding/geocoder_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ you to use the given objects like they are. The ``ivory_google_map.geocoder_requ
configuration describes below is this default configuration but if you don't provide at least one value (for the
`geocoder` or `geocoder_request` nodes), the service will not be registered.

```
```yaml
# app/config/config.yml

ivory_google_map:
Expand Down
1 change: 1 addition & 0 deletions Resources/doc/usage/services/geocoding/ivory_geocoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ foreach ($results as $result) {
// ...
}
}
```

#### Geometry informations

Expand Down

0 comments on commit 2b4db99

Please sign in to comment.