Skip to content

Commit

Permalink
doc typos
Browse files Browse the repository at this point in the history
  • Loading branch information
jwkaltz committed Mar 11, 2019
1 parent fde46b7 commit c967923
Show file tree
Hide file tree
Showing 14 changed files with 122 additions and 118 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
/doc/index.rst
/doc/developer/server_side.rst
/doc/integrator/create_application.rst
/doc/integrator/ngeo.rst
/doc/integrator/upgrade_application.rst
/dist/
/docker-compose.yaml
Expand Down
40 changes: 20 additions & 20 deletions doc/administrator/administrate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ All layer type
All the layers in the admin interface have the following attributes:

* ``Name``: the name of the WMS layer/group, or the WMTS layer.
It also used throw OpenLayers.i18n to display the name on the layers tree.
It is also used by OpenLayers.i18n, to display the name on the layers tree.
* ``Public``: make the layer public, also it is accessible
throw the ``Restriction areas``.
through the ``Restriction areas``.
* ``Restrictions area``: the areas through which the user can see the layer.
* ``Related Postgres table``: the related postgres table,
used by the :ref:`administrator_editing`.
Expand All @@ -98,12 +98,12 @@ WMS layer
On internal WMS layers we have the following specific attributes:

* ``OGC Server``: the used server.
* ``Layers``: the WMS layers. Can be one layer, one group, a coma separated list of layers.
In the case of a coma separated list of layers, we will get the legend rule for the
* ``Layers``: the WMS layers. Can be one layer, one group, a comma separated list of layers.
In the case of a comma separated list of layers, we will get the legend rule for the
layer icon on the first layer, and the legend will not be supported we should define a legend metadata.
* ``Style``: the used style, can be empty.
* ``Style``: the style used, can be empty.
* ``Time mode``: used for the WMS time component.
* ``Time widget``: the used component type for the WMS time.
* ``Time widget``: the component type used for the WMS time.

WMTS layer
~~~~~~~~~~
Expand All @@ -112,9 +112,9 @@ On WMTS layers we have the following specific attributes:

* ``GetCapabilities URL``: the URL to the WMTS capabilities.
* ``Layer``: the WMTS layer.
* ``Style``: the used style, if not present we use the default style.
* ``Matrix set``: the used matrix set, if there is only one matrix set
in the capabilities it can be empty.
* ``Style``: the style used; if not present, we use the default style.
* ``Matrix set``: the matrix set used; if there is only one matrix set
in the capabilities, it can be empty.

layerv1 (deprecated in v2)
~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -126,7 +126,7 @@ The layers in the admin interface have the following attributes:
* ``Checked``: the layer is checked by default.
* ``Icon``: icon on the layer tree.
* ``KML 3D``: optional, URL to a KML to display it on the Google earth view.
* ``Display legend``: it checked the legend is display on the layer tree.
* ``Display legend``: if checked, the legend is displayed on the layer tree.
* ``Legend image``: URL to overwrite the default legend image.
* ``Min/Max resolution``: resolutions between which data are displayed by
the given layer, used to zoom to visible scale, with WMS if it is empty
Expand All @@ -135,30 +135,30 @@ The layers in the admin interface have the following attributes:
* ``Identifier attribute field``: field used to identify a feature from the layer, e.g.: 'name'.
* ``Restrictions area``: the areas through which the user can see the layer.

On ``internal WMS`` layers we have the following specific attributes:
On ``internal WMS`` layers, we have the following specific attributes:

* ``Image type``: the type of the images.
* ``Style``: the used style, can be empty.
* ``Style``: the style used, can be empty.
* ``Dimensions``: a JSON string that gives the dimensions,
e.g.: ``{ "YEAR": "2012" }``, if not provided default values are used.
* ``Legend rule``: the legend rule used to get the layer icon,
if empty we use the ``Icon``.

On ``external WMS`` layer we have the following specific attributes:
On ``external WMS`` layers, we have the following specific attributes:

* ``Base URL``: the base URL of the WMS server.
* ``Image type``: the type of the images.
* ``Style``: the used style, can be empty.
* ``Style``: the style used, can be empty.
* ``Legend rule``: the legend rule used to get the layer icon,
if empty we use the ``Icon``.
* ``Single tile``: use the single tile mode.

On ``WMTS`` layer we have the following specific attributes:
On ``WMTS`` layers, we have the following specific attributes:

* ``Base URL``: the URL to the WMTS capabilities.
* ``Style``: the used style, if not present we use the default style.
* ``Matrix set``: the used matrix set, if there is only one matrix set
in the capabilities it can be empty.
* ``Style``: the style used;, if not present, we use the default style.
* ``Matrix set``: the matrix set used; if there is only one matrix set
in the capabilities, it can be empty.
* ``WMS server URL``: optional, URL to a WMS server to use for printing
and querying. The URL to the internal WMS is used if this field is not
specified.
Expand Down Expand Up @@ -203,8 +203,8 @@ LayerGroup

Attributes:

* ``Name``: used throw OpenLayers.i18n to display the name on the layers tree.
* ``Order``: used to order the layers and group on the layer tree.
* ``Name``: used by OpenLayers.i18n to display the name on the layer tree.
* ``Order``: used to order the layers and groups on the layer tree.
* ``Metadata URL``: optional (deprecated in v2).
* ``Expanded``: is expanded on the layer tree by default (deprecated in v2).
* ``Internal WMS``: if true it can include only ``Internal WMS`` layers,
Expand Down
8 changes: 4 additions & 4 deletions doc/administrator/editing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ Editing
This section describes how to set up feature editing in c2cgeoportal
applications.

Just like most administrative tasks setting up editing in a c2cgeoportal
Just like most administrative tasks, setting up editing in a c2cgeoportal
application involves intervening in the database, through the c2cgeoportal
administration interface.

Requirements
------------

To be editable a layer should satisfy the following requirements:
To be editable, a layer should satisfy the following requirements:

1. It should be accessible with WMS, and correctly configured in the
mapfile. See :ref:`administrator_mapfile`.
Expand Down Expand Up @@ -75,8 +75,8 @@ by selecting the *Layers* item in the admin interface's menu.

For a *layer* to be editable its ``geoTable`` field should be set. This field
is the name of the PostGIS table containing the layer's geographic data. It is
string of the form ``[<schemaname>.]<tablename>``. If ``schemaname`` is
omitted the table is assumed to be in the ``public`` schema. The label
a string of the form ``[<schemaname>.]<tablename>``. If ``schemaname`` is
omitted, the table is assumed to be in the ``public`` schema. The label
corresponding to this field is *Related Postgres table* in the admin interface.

.. warning::
Expand Down
2 changes: 1 addition & 1 deletion doc/administrator/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ application.

The application administrator configures and administrates the application
through the database. The administrator does not deal with the files of the
application (the integrator is the one responsible for these files). Except for
application (the integrator is the one responsible for these files), except for
the map server files. Adding layers to the application indeed requires
inserting information in the database, as well as adding layers in the map
server.
Expand Down
40 changes: 20 additions & 20 deletions doc/administrator/mapfile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Mapfile configuration
=====================

As mentioned on the index page (:ref:`administrator_guide`) the application
administrator manages the application through the database, and the
application's MapServer mapfile.
administrator manages the application through the database and via
the application's MapServer mapfile.

The application's mapfile is where WMS and WFS layers are defined. WMS is used
for the map (``WMS GetMap``), and for the ``point query`` feature (``WMS
Expand Down Expand Up @@ -34,7 +34,7 @@ and/or *private* (a.k.a *restricted*).
Print
-----

MapFish Print does single tile requests to the WMS server. For that reason we
MapFish Print performs single tile requests to the WMS server. For that reason we
need to use a relatively large value for the ``MAXSIZE`` parameter (of the
``MAP`` section); 5000 for example.

Expand Down Expand Up @@ -104,7 +104,7 @@ example::
.. warning::

The geometry columns of layers involved in ``box query`` should have the
same name. By default the WFS GetFeatue CGXP plugin
same name. By default the WFS GetFeature CGXP plugin
(``cgxp_wfsgetfeature``) assumes the name is ``geom``, but the plugin
can be configured to use a different name.

Expand Down Expand Up @@ -150,7 +150,7 @@ example::
``gml_<geometry name>_type``

This specifies the type of a geometry column. Specifying this property is
necessary if geometries, instead of bboxes should be returned in
necessary if geometries, instead of bboxes, should be returned in
GetFeatureInfo (GML) responses. ``<geometry name>`` should be replaced the string set
with the ``gml_geometries``. For example, if ``geom_geometries`` is set to
``the_geom`` then ``gml_the_geom_type`` should be used.
Expand All @@ -166,23 +166,23 @@ See the `WMS Server MapFile Documentation
Restricted layer
----------------

The restricted layers work only with postgres data. All layer defined as
The restricted layers work only with PostgreSQL data. All layers defined as
restricted in the mapfile should be defined as well in the admin interface
and vice versa.

With a RestrictionArea area
~~~~~~~~~~~~~~~~~~~~~~~~~~~

A RestrictionArea is used to restricted the layer displaying to a given area.
A RestrictionArea is used to restrict the layer displaying to a given area.
This area is specified in the administration interface while defining the
``RestrictionArea`` element.

.. warning::

Using an restriction area on a big layer or defining a too complex area
Using a restriction area on a big layer or defining a very complex area
may slow down the application.

To define a restricted layer in the Mapfile the ``DATA`` property of the
To define a restricted layer in the Mapfile, the ``DATA`` property of the
``LAYER`` should look like this::

DATA "the_geom FROM
Expand Down Expand Up @@ -240,7 +240,7 @@ It is defined as follows:
Without restriction on the RestrictionArea area
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If we do not need to restrict on an area we can use the following
If we do not need to restrict on an area, we can use the following
``DATA`` property of the ``LAYER``::

DATA "the_geom FROM (
Expand Down Expand Up @@ -300,7 +300,7 @@ Variable Substitution
---------------------

It is possible to adapt some values in the mapfile according to the user's role
by using variable substitution. For instance to hide some layer objects
by using variable substitution, for instance to hide some layer objects
attributes. The list of parameters that support variable substitution is
available `here <http://mapserver.org/cgi/runsub.html#parameters-supported>`_.

Expand All @@ -311,7 +311,7 @@ section in the MapFile and add::
"s_<variable>" "<validation_pattern>"

The ``validation_pattern`` is a regular expression used to validate the
argument. For example if you only want lowercase characters and commas,
argument. For example, if you only want lowercase characters and commas,
use ``^[a-z,]*$``.

Now in ``LAYER`` place ``%s_<variable>%`` where you want to
Expand All @@ -320,7 +320,7 @@ insert the variable value, but not at the start of a line (to avoid escape issue
Then in the administration interface, create a ``functionality`` named
``mapserver_substitution`` with the value: ``<variable>=<value>``.

Please note that we cannot use substitution in the ``MATADATA`` values.
Please note that we cannot use substitution in the ``METADATA`` values.
As a result, if you would like to adapt the list of attributes returned in a
WFS GetFeature or WMS GetFeatureInfo request, you have to adapt the columns
listed in the ``DATA`` section. For instance::
Expand Down Expand Up @@ -350,8 +350,8 @@ interface with for instance the following value for the given role:

.. note::

We are also able to use the ``role_id`` and ``user_id`` as
variable substitution, but they are not available for cached query like:
You can also use variable substitution for the ``role_id`` and ``user_id``,
but beware that these attributes are not available for cached queries like:
``GetCapabilities``, ``GetLegendGraphic``, ``DescribeFeatureType``.

`MapServer documentation <http://mapserver.org/cgi/runsub.html>`_
Expand Down Expand Up @@ -403,22 +403,22 @@ because it saves MapServer from computing the extent of all layer features.
Prepare raster files
~~~~~~~~~~~~~~~~~~~~

To have good performance you should have tiled files with overview, and probably
a tileindex, you can doing these steps:
To achieve good performance, you should have tiled files with overview, and ideally
a tileindex, you can achieve this with these steps:

Convert your rasters in tiled GeoTIFF:

.. code::
gdal_translate -of GTiff -co "TILED=YES" -co "TFW=YES" <filename_in.tif> <filename_out.tif>
Then build overviews for your rasters
Then build overviews for your rasters:

.. code::
gdaladdo -r average filename.tif 2 4 8 16
You can generate a shapefile indexing all your rasters
You can generate a shapefile indexing all your rasters:

.. code::
Expand All @@ -432,6 +432,6 @@ images and has memory leaks with ECW. See this
`MapServer ticket <http://trac.osgeo.org/mapserver/ticket/3245>`_
for example.

If you still want to use it then replace ``SetHandler fcgid-script``
If you still want to use it, then replace ``SetHandler fcgid-script``
by ``SetHandler cgi-script`` in the ``apache/mapserver.conf.mako``
file. But note that this affects performance.
11 changes: 5 additions & 6 deletions doc/administrator/tinyows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

WFS-T with TinyOWS
==================
Based on `TinyOWS <http://mapserver.org/tinyows/>`__ c2cgeoportal layers can be
Based on `TinyOWS <http://mapserver.org/tinyows/>`__, c2cgeoportal layers can be
edited via WFS-T, for example using QGIS as a client. c2cgeoportal acts as a
proxy to TinyOWS to limit access to authorized users.

Expand Down Expand Up @@ -83,8 +83,8 @@ In the root element ``tinyows`` the following properties have to be set:
4. ``log_level`` - The log level (default: 1). Please refer to the
`TinyOWS documentation <http://mapserver.org/tinyows/configfile.html#tinyows-element>`__
for more information.
5. ``check_schema`` - If the input data is validated against the schema when
creating new features. In a vhost environment the schema check has to be
5. ``check_schema`` - Defines if the input data is validated against the schema when
new features are created. In a vhost environment, the schema check has to be
disabled, so that the proxy can function properly. This does not disable
the validation database-side though!

Expand All @@ -105,7 +105,7 @@ The layers that should be accessible with TinyOWS have to specified with
title="Points"
pkey="id" />

In this example a layer named ``point`` is created for table ``point`` in the
In this example a layer named ``point`` is created for the table ``point`` in the
database schema ``edit`` with the primary key column ``id``. This layer is both
``retrievable`` and ``writable``.

Expand All @@ -126,9 +126,8 @@ access to a layer to the users of a restriction-area.
`TinyOWS documentation <http://mapserver.org/tinyows/configfile.html#layer-element>`__
for more information.

After the configuration is made, re-build the c2cgeoportal application::
After the configuration is made, re-build your c2cgeoportal application as usual.

make docker-build

Editing a layer with WFS-T
--------------------------
Expand Down
12 changes: 6 additions & 6 deletions doc/administrator/wmstime.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ date, an end date and an interval between the time stops.
The format ``value1,value2,value3,...`` allows specifying a time range by
listing discrete values.

The dates (``min``, ``max`` and ``valueN``) could be specified using any of the
The dates (``min``, ``max`` and ``valueN``) can be specified using any of the
following formats:

* ``YYYY``
Expand All @@ -50,16 +50,16 @@ requests. For example when a layer has monthly data, the ``YYYY-MM`` should be
used in the mapfile to make sure that only months and years are displayed in the
slider tip and passed to the GetMap request.

The interval (``interval``) has to be defined regarding international standard
ISO 8601 and its duration/time intervals definition (see
The interval (``interval``) has to be defined according to the
ISO 8601 standard and its duration/time intervals definition (see
`ISO 8601 Durations / Time intervals <http://en.wikipedia.org/wiki/ISO_8601#Durations>`_).

Some examples for the interval definition:

* An interval of one year: ``P1Y``
* An interval of six months: ``P6M``

For more information please refer to the `MapServer documentation
For more information, please refer to the `MapServer documentation
<http://mapserver.org/ogc/wms_time.html>`_.

Admin interface
Expand All @@ -71,7 +71,7 @@ Two different widget types are available: A time slider and a datepicker
widget. The preferred widget can be selected in the admin interface (field
``Time widget``).

Besides, the time mode can be changed. The time mode is one of:
Note that the time mode can be changed. The time mode is one of:

* ``value``
* ``range``
Expand Down Expand Up @@ -108,5 +108,5 @@ Some of those limitations apply to the mapfile:

There is also a limitation that applies to the admin interface: all the WMS Time
layers of a group should be configured to use the same widget and the same time mode
(``single`` or ``range``) except for layers with time mode ``disabled`` that can be mixed
(``single`` or ``range``), except for layers with time mode ``disabled`` that can be mixed
within others.
2 changes: 1 addition & 1 deletion doc/index.rst.mako
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ One of the primary goals of the c2cgeoportal project is sharing as much as
functionality and code as possible between applications. *Do not repeat
ourselves!*

`Demo <https://geomapfish-demo.camptocamp.net/${major_version}>`_,
`Demo <https://geomapfish-demo.camptocamp.com/${major_version}>`_,
`with features grid <https://camptocamp.github.io/ngeo/${major_version}/examples/contribs/gmf/apps/desktop_alt/>`_,
to test the editing you can use the username 'demo' with the password 'demo'.

Expand Down
Loading

0 comments on commit c967923

Please sign in to comment.