From 7250784366cfe9a0cac787c65cd7338cc5e14c75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9lia=20Prat?= Date: Wed, 16 Oct 2024 14:03:07 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20[DOC]=20Fix=20some=20typos?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/installation.rst | 4 ++-- docs/usage.rst | 24 ++++++++++++------------ 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index f17714f..de6ac21 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -5,14 +5,14 @@ Installation Requirements ************ -* You need to install geodjango required libraries (See `here `_) +* You need to install geodjango required libraries. (See `here `_) PostGIS 2.4+ backend usage ************************** * You need a PostgreSQL database with PostGIS 2.4+ extension enabled. (See ``_) -* You need to enable and use **django.contrib.gis.db.backends.postgis** database backend +* You need to enable and use **django.contrib.gis.db.backends.postgis** database backend. .. code-block:: bash diff --git a/docs/usage.rst b/docs/usage.rst index f301f40..23e572d 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -2,11 +2,11 @@ Usage ===== -A vector tile is composed by vector layers which represent different kind of data. Each layer is composed by features. +A vector tile is composed of vector layers which represent different kinds of data. Each layer is composed of features. To start using django-vectortiles, you need GeoDjango models with geometries. -Then, you need to describe how your data will be embed in tiles. +Then, you need to describe how your data will be embedded in tiles. Start by creating vector layers for your data... @@ -36,7 +36,7 @@ Start by creating vector layers for your data... # all attributes available in vector layer definition can be defined -Well. your vector layer is ready. next step is to create a tile class and a view to serve it. +Well, your vector layer is ready. The next step is to create a tile class and a view to serve it. Simple layer tile view @@ -65,7 +65,7 @@ Simple layer tile view Multiple layer tile view ************************ -As vector tile layer permit it, you can embed multiple layers in your tile. +As vector tile layer permits it, you can embed multiple layers in your tile. Let's create a second layer. @@ -99,10 +99,10 @@ Let's create a second layer. Using TileJSON ************** -It's a good practice to use tilejson to tell to your map library how to gt your tiles and their defintion. -django-vectortiles permit that. +It's a good practice to use TileJSON to tell to your map library how to get your tiles and their definition. +django-vectortiles permits that. -TileJSON and tile views share some data, as vactor layers definition. So we need to factorize some things. +TileJSON and tile views share some data, as vector layers definitions. So we need to factorize some things. .. code-block:: python @@ -129,15 +129,15 @@ TileJSON and tile views share some data, as vactor layers definition. So we need ... ] -Now you can use your tiles with a map library like MapLibre or Mapbox GL JS, directly wit hthe tileJSON provided. +Now you can use your tiles with a map library like MapLibre or Mapbox GL JS, directly with the provided TileJSON. .. warning:: - By default, it's your browser URL that will be used to generate tile url in tilejson. Take care about django and SSL configuration (django settings, web server headers) if you want to generate an URL with https:// + By default, it's your browser's URL that will be used to generate tile urls in TileJSON. Take care of Django and SSL configuration (Django settings, web server headers) if you want to generate an URL with https:// .. note:: - If your application is hosted on server with many workers, and you want to optimized tile loading, you can add several urls in your tilejson file. + If your application is hosted on a server with many workers, and you want to optimize tile loading, you can add several urls in your TileJSON file. .. code-block:: python @@ -155,13 +155,13 @@ Now you can use your tiles with a map library like MapLibre or Mapbox GL JS, dir "https://c.tiles.xxxx", ] - With these settings, each tilejson file will contain several urls, and your map library will be able to parallel load tiles at time. + With these settings, each TileJSON file will contain several urls, and your map library will be able to parallel load tiles at time. More complex multiple layer tile view ************************************* -You can customize geometry data embed in your tiles. +You can customize the geometry data embedded in your tiles. .. code-block:: python