Recent changes to Label

Label modified by Agnar Renolen

Agnar Renolen — Sat, 27 Dec 2014 18:55:42 -0000

--- v2
+++ v3
@@ -41,9 +41,7 @@
 * **horizontal** (default) - the text will be placed horizontally.

 ##### shift
-Specifies, in paper units, an additional shift from the
-reference point and the text point.  Positive values is in the
-direction of the text.  Default value is `0pt`.
+Specifies, in paper units, an additional shift from the reference point and the text point.  Positive values is in the direction of the text.  Default value is `0pt`.

 ##### align
 Specifies text-alignment for the label. Legal values are

Label modified by Agnar Renolen

Agnar Renolen — Sat, 27 Dec 2014 18:41:10 -0000

--- v1
+++ v2
@@ -1,66 +1,57 @@
 Label
-=====
-
-The Label element provides a way of adding any arbitrary text elements
-to the frame, such as a title.  
-
-Depending on the application parsing the XML-file, it may be possible to
-specify place holders that will be substituted by the application.  For
-example, if the label contains the text $SHEED_ID$ the application may
-substitute te text with a sheet identifier. Otherwise it may just
-provide the text verbatim.
-
-Currently **mapframer** does not support such variable substitution.
+======
+The Label element provides a way of adding any arbitrary text elements to the frame, such as a title.

 Attributes
 ----------

-* **font**
+##### font
 Specifies the name of the font to be used.

-* **size**
+##### size
 Specifies the size of the font to be used, in paper units.

-* **color**
+##### color
 Specifies the color of the label.

-* **anchor**
-Specifes an anchor point relative to the main frame of which the text will be placed relative to. The following values are legal:
+##### anchor
+Specifies an anchor point relative to the main frame of which the text will be placed relative to. The following values are legal:

-    * **top-left**
-    * **top-center** (default)
-    * **top-right**
-    * **center-left**
-    * **center-right**
-    * **bottom-left**
-    * **bottom-center**
-    * **bottom-right**
+* **top-left**
+* **top-center** (default)
+* **top-right**
+* **center-left**
+* **center-right**
+* **bottom-left**
+* **bottom-center**
+* **bottom-right**

-* **offset**
+##### offset
 Specifies, in paper units, the distance from the main frame to the label. Positive values are outwards. Labels anchored to the corners of the main frame, are offset diagonally from the corner, but at a distance measured perpendicular to the main frame sides.

 Default value is `0pt`.

-* **orientation**
+##### orientation
 Specifies the text orientation. The following three values are legal:

-    * **outward** - the text will be blaced with its bottom towards the main frame. 
+* **outward** - the text will be placed with its bottom towards the main frame. 
       A label anchored to the bottom and oriented outward will be placed upside down.
-    * **inward** - the text will be placed with its top topwards the main frame. 
-      A label anchored to the top and  oriented inward will be placed updsied down.
-    * **horizontal** (default) - the text will be placed horizontally.
+* **inward** - the text will be placed with its top upwards the main frame. 
+      A label anchored to the top and  oriented inward will be placed upside down.
+* **horizontal** (default) - the text will be placed horizontally.

-* **shift**
+##### shift
 Specifies, in paper units, an additional shift from the
 reference point and the text point.  Positive values is in the
 direction of the text.  Default value is `0pt`.

-* **align**
-Specifes text-alignment for the label. Legal values are
-    * **left**
-    * **right**
-    * **center**
-    * **auto** (default) - determined from the anchor point.
+##### align
+Specifies text-alignment for the label. Legal values are
+
+* **left**
+* **right**
+* **center**
+* **auto** (default) - determined from the anchor point.

 Content
 -------

Label modified by Agnar Renolen

Agnar Renolen — Thu, 25 Dec 2014 22:28:02 -0000

Label

The Label element provides a way of adding any arbitrary text elements
to the frame, such as a title.

Depending on the application parsing the XML-file, it may be possible to
specify place holders that will be substituted by the application. For
example, if the label contains the text $SHEED_ID$ the application may
substitute te text with a sheet identifier. Otherwise it may just
provide the text verbatim.

Currently mapframer does not support such variable substitution.

Attributes

font
Specifies the name of the font to be used.
size
Specifies the size of the font to be used, in paper units.
color
Specifies the color of the label.
anchor
Specifes an anchor point relative to the main frame of which the text will be placed relative to. The following values are legal:
- top-left
- top-center (default)
- top-right
- center-left
- center-right
- bottom-left
- bottom-center
- bottom-right
offset
Specifies, in paper units, the distance from the main frame to the label. Positive values are outwards. Labels anchored to the corners of the main frame, are offset diagonally from the corner, but at a distance measured perpendicular to the main frame sides.

Default value is 0pt.

orientation
Specifies the text orientation. The following three values are legal:
- outward - the text will be blaced with its bottom towards the main frame.
  A label anchored to the bottom and oriented outward will be placed upside down.
- inward - the text will be placed with its top topwards the main frame.
  A label anchored to the top and oriented inward will be placed updsied down.
- horizontal (default) - the text will be placed horizontally.
shift
Specifies, in paper units, an additional shift from the
reference point and the text point. Positive values is in the
direction of the text. Default value is 0pt.
align
Specifes text-alignment for the label. Legal values are
- left
- right
- center
- auto (default) - determined from the anchor point.

Content

This is one of two elements that contain any text, which is the text of the label.

Example

<Label font="Times-Bold" 
       size="36pt" 
       anchor="top-center"  
       offset="15mm" 
       orientation="horizontal" 
       shift="0" 
       align="center">Bymarka</Label>