Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes some layout and formatting issue in handbook #1107

Merged
merged 5 commits into from
Dec 17, 2020
Merged

Fixes some layout and formatting issue in handbook #1107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
39dd029
Fixes minor formatting issue and and a wrong value for EnableResponse…
tfr42 Dec 1, 2020
728f110
fixes formatting errors in filtering section
tfr42 Dec 1, 2020
2613940
fixes formatting issues in lists
tfr42 Dec 1, 2020
319913d
improves the toc placement by placing it left, allows navigating toc …
tfr42 Dec 1, 2020
1f7d782
upgrades asciidoc maven plugin to version 2.1.0 and pdf creator to 1.5.3
tfr42 Dec 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions deegree-services/deegree-webservices-handbook/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-pdf</artifactId>
<version>1.5.0-beta.2</version>
<version>1.5.3</version>
</dependency>
</dependencies>
<executions>
Expand Down Expand Up @@ -101,7 +101,7 @@
<doctype>book</doctype>
<backend>html</backend>
<attributes>
<toc />
<toc>left</toc>
<linkcss>false</linkcss>
<revdate>${revdate}</revdate>
<revnumber>${revnumber}</revnumber>
Expand Down
4 changes: 2 additions & 2 deletions deegree-services/deegree-webservices-handbook/src/main/asciidoc/basics.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,12 @@ The following diagram shows the different types of resources and their
dependencies. The deegree configuration can be divided into several
sections:

----

* web sevrices
* data stores
* map layers
* server connections
----


For example, to offer a Web Feature Service, a feature store (based on a
shapefile, database, etc) must be configured. With a rasterfile, like a
Expand Down
3 changes: 2 additions & 1 deletion deegree-services/deegree-webservices-handbook/src/main/asciidoc/featurestores.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,7 +673,8 @@ _cities_.
*SQL feature store: Mapping two tables*

[source,xml]
----<SQLFeatureStore configVersion="3.4.0"
----
<SQLFeatureStore configVersion="3.4.0"
xmlns="http://www.deegree.org/datasource/feature/sql"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.deegree.org/datasource/feature/sql
Expand Down
91 changes: 38 additions & 53 deletions ...ree-services/deegree-webservices-handbook/src/main/asciidoc/filterencoding.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,11 @@ In the following, FE 1.1.0 syntax is used.

FE enables the use of the following arithmetic operators:

----
* Add: used for addition
* Sub: used for substraction
* Mul: used for multiplication
* Div: used for division
----
* `Add`: used for addition
* `Sub`: used for substraction
* `Mul`: used for multiplication
* `Div`: used for division


*Example:*

Expand All @@ -41,11 +40,10 @@ FE enables the use of the following arithmetic operators:

FE enables the use of the following logical operators:

----
* And: Links two conditions with AND
* Or: links two conditions with OR
* Not: negates a condition
----
* `And`: Links two conditions with AND
* `Or`: links two conditions with OR
* `Not`: negates a condition


*Example:*

Expand All @@ -62,25 +60,16 @@ FE enables the use of the following logical operators:
deegree has implementations for the following list of comparison
operators:

----
* PropertyIsEqualTo: Evaluates if a property value equals to another
value.
* PropertyIsNotEqualTo: Evaluates if a property value differs from
another value.
* PropertyIsLessThan: Evaluates if a property value is smaller than
another value.
* PropertyIsGreaterThan: Evaluates if a property value is greater than
another value.
* PropertyIsLessThanOrEqualTo: Evaluates if a property value is smaller
than or equal to another value.
* PropertyIsGreaterThanOrEqualTo: Evaluates if a property value is
greater than or euqal to another value.
* PropertyIsLike: Evaluates if a property value is like another value.
It compares string values which each other.
* PropertyIsNull: Evaluates if a property value is NULL.
* PropertyIsBetween: Evaluates if a property value is between 2 defined
values.
----
* `PropertyIsEqualTo`: Evaluates if a property value equals to another value.
* `PropertyIsNotEqualTo`: Evaluates if a property value differs from another value.
* `PropertyIsLessThan`: Evaluates if a property value is smaller than another value.
* `PropertyIsGreaterThan`: Evaluates if a property value is greater than another value.
* `PropertyIsLessThanOrEqualTo`: Evaluates if a property value is smaller than or equal to another value.
* `PropertyIsGreaterThanOrEqualTo`: Evaluates if a property value is greater than or euqal to another value.
* `PropertyIsLike`: Evaluates if a property value is like another value. It compares string values which each other.
* `PropertyIsNull`: Evaluates if a property value is NULL.
* `PropertyIsBetween`: Evaluates if a property value is between 2 defined values.


*Example:*

Expand All @@ -96,23 +85,19 @@ values.

With deegree you can make use of the following spatial operators:

----
* Equals: Evaluates if geometries are identical
* Disjoin: Evaluates if geometries are spatially disjoined
* Touches: Evaluates if geometries are spatially touching
* Within: Evaluates if a geometry is spatially within another
* Overlaps: Evaluates if geometries are spatially overlapping
* Crosses: Evaluates if geometries are spatially crossing
* Intersects: Evaluates if geometries are spatially intersecting. This
is meant as the opposite of disjoin.
* Contains: Evaluates if a geometry spatially contains another.
* DWithin: Evaluates if a geometry is within a specific distance to
another.
* Beyond: Evaluates if a geometry is beyond a specific distance to
another.
* BBOX: Evaluates if a geometry spatially intersects with a given
bounding box.
----

* `Equals`: Evaluates if geometries are identical
* `Disjoin`: Evaluates if geometries are spatially disjoined
* `Touches`: Evaluates if geometries are spatially touching
* `Within`: Evaluates if a geometry is spatially within another
* `Overlaps`: Evaluates if geometries are spatially overlapping
* `Crosses`: Evaluates if geometries are spatially crossing
* `Intersects`: Evaluates if geometries are spatially intersecting. This is meant as the opposite of disjoin.
* `Contains`: Evaluates if a geometry spatially contains another.
* `DWithin`: Evaluates if a geometry is within a specific distance to another.
* `Beyond`: Evaluates if a geometry is beyond a specific distance to another.
* `BBOX`: Evaluates if a geometry spatially intersects with a given bounding box.


*Example:*

Expand All @@ -130,8 +115,8 @@ bounding box.
</Overlaps>
----

TIP: For further reading on spatial operators, please refer to the OGC Simple
Features Specification For SQL.
TIP: For further reading on spatial operators, please refer to the
https://www.ogc.org/standards/sfs[OGC Simple Features Specification For SQL].

=== Filter expressions

Expand All @@ -154,7 +139,7 @@ section gives some examples for the use of such filter expressions.
----

This filter expressions shows, how filter expressions with a comparative
filter are constructed In the concrete example, the property
filter are constructed. In the example above, the property
SomeProperty is evaluated, if it equals to the value of "100".

===== Spatial filter expression
Expand All @@ -176,8 +161,8 @@ SomeProperty is evaluated, if it equals to the value of "100".
----

This filter expressions shows, how filter expressions with a spatial
filter are constructed. In the concrete case, the defined filter looks
up, if the property geometry overlaps with the define polygon of ...
filter are constructed. In this example, the defined filter looks
up, if the property geometry overlaps with the defined polygon of "..." (geometry values removed for better readability).

==== Advanced filter expressions

Expand Down Expand Up @@ -206,7 +191,7 @@ up, if the property geometry overlaps with the define polygon of ...

This more complex filter expressions shows, how to make use of
combinations of filter operators. THe given filter expression evaluates
if the value of the property DEPTH is smaller than "30" AND if the
if the value of the property DEPTH is smaller than "30" *and* if the
geometry property named Geometry is spatially disjoint with the given
envelope.

Expand Down
38 changes: 15 additions & 23 deletions deegree-services/deegree-webservices-handbook/src/main/asciidoc/renderstyles.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,23 +92,19 @@ from it.
Depending on the type of symbolization to create, one of the following
symbolizers can be used:

----
* <PointSymbolizer>
* <LineSymbolizer>
* <PolygonSymbolizer>
* <TextSymbolizer>
* <RasterSymbolizer>
----

Symbolizers can have an uom-attribute (units of measure), which
determines the unit of all values set inside the Symbolizer. The
following values for UoM are supported within deegree:

----
* uom="pixel"
* uom="meter"
* uom="mm"
----

The default value is "pixel".

Expand All @@ -120,7 +116,7 @@ FeatureType will be used.
Each of the (Vector-)Symbolizer-elements has its dimensions, which are
described in more detail below:

----

* *<LineSymbolizer>* has only one dimension: the <Stroke>-element (to
style the stroke).
* *<PolygonSymbolizer>* has two dimensions: the <Stroke> (to sytle the
Expand All @@ -132,26 +128,25 @@ inside of the point).
* *<TextSymbolizer>* has three dimensions: the <Label> (to set the
property, which is to be styled), the <Font> (to style the font) and the
<Fill>-element (to style the inside of the font).
----


===== Stroke

To describe a <Stroke>, a number of different <SvgParameter> can be
used.

----
* name="stroke" ==> The stroke (color) is defined by the hex color code
* `name="stroke"` => The stroke (color) is defined by the hex color code
(e.g. black ==> #000000).
* name="opacity" ==> Opacity can be set by a percentage number, written
as decimal (e.g. 0,25 ==> 25% opacity).
* name="with" ==> Wide or thin, set your stroke-width however you want.
* name="linecap" ==> For linecap (ending) a stroke you can choose the
* `name="opacity"` => Opacity can be set by a percentage number, written
as decimal (e.g. 0,25 => 25% opacity).
* `name="with"` => Wide or thin, set your stroke-width however you want.
* `name="linecap"` => For linecap (ending) a stroke you can choose the
following types: round, edged, square, butt.
* name="linejoin" ==> Also there are different types of linejoin
* `name="linejoin"` => Also there are different types of linejoin
possibilities: round, mitre, bevel.
* name="dasharray" ==> The dasharray defines where the stroke is painted
and where not (e.g. "1 1" ==> - - - ).
----
* `name="dasharray"` => The dasharray defines where the stroke is painted
and where not (e.g. "1 1" => - - - ).


[source,xml]
----
Expand All @@ -176,10 +171,8 @@ For the visualization of polygons, points and texts, the <Fill> element
can be used additional to styling the <Stroke>. You can set the
following <SvgParameter>:

----
* name="fill" (color)
* name="fill-opacity"
----

These two <SvgParameter> are working like those from <Stroke>.

Expand All @@ -206,13 +199,12 @@ displayed text have to be set. Every <TextSymbolizer> needs a <Label> to
be specified. The <Font> to be used for the text symbolization can be
set with <SvgParameter> elements. These are the possible <SvgParameter>:

----
* name="font-family" ==> Possible types are: e.g. Arial, Times Roman,
* `name="font-family"` => Possible types are: e.g. Arial, Times Roman,
Sans-Serif
* name="font-weight" ==> Possible types are: normal, bold, bolder,
* `name="font-weight"` => Possible types are: normal, bold, bolder,
lighter
* name="font-size"
----
* `name="font-size"` => Possible values are integer values


With a <Fill>-element a color and opacity of the font can be defined.
This method is used to show text which is stored in your database.
Expand Down
8 changes: 4 additions & 4 deletions deegree-services/deegree-webservices-handbook/src/main/asciidoc/webservices.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ streamed to the client. This is very much recommended and even a
requirement for transferring large responses efficiently. The only
drawback happens if exceptions occur, after a partial response has
already been transferred. In this case, the client will receive part
payload and part exception report. By specifying _false_ here, you can
payload and part exception report. By specifying _true_ here, you can
explicitly force buffering of the full response, before it is written to
the client. Only if the full response could be generated successfully,
it will be transferred. If an exception happens at any time the buffer
Expand Down Expand Up @@ -228,7 +228,7 @@ parameter is present in a request).
* _QueryMaxFeatures_: By default, a maximum number of 15000 features
will be returned for a single _GetFeature_ request. Use this option to
override this setting. A value of _-1_ means unlimited.
* ''ResolveTimeOutInSeconds'': Use this option to specify a default
* _ResolveTimeOutInSeconds_: Use this option to specify a default
value for ResolveTimeOut, used in _GetFeature_ request if the
ResolveTimeOut option is not set.
* _QueryCheckAreaOfUse_: By default, spatial query constraints are not
Expand Down Expand Up @@ -1326,15 +1326,15 @@ _selector2_
Any mime type of the following output formats can be configured to be
available as response format for GetMap requests.

----

* _image/png_
* _image/png; subtype=8bit_
* _image/png; mode=8bit_
* _image/gif_
* _image/jpeg_
* _image/tiff_
* _image/x-ms-bmp_
----


If no format has been configured, all formats are supported.

Expand Down
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>1.6.0</version>
<version>2.1.0</version>
</plugin>
</plugins>
</pluginManagement>
Expand Down