Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

All the content of the element will be replaced by the default (and then the user input) text. Any text entered outside the ## characters will be ignored Ee.g.:

Code Block
languagexml
<span class="ishare-edit-inline">Here's some ##words.words on a page##, nice!</span>

...

which will be replaced in turn by whatever the user enters into the Words input box in the dialog sidebar.

Code Block
languagexml
titleBad Example
<span class="ishare-inline-edit">This document was produced for ##purpose.INSERT RECIPIENT##, please do not copy without permission.</span>

Any text you wish to display must be outside the <span> e.g.:

Code Block
languagexml
titleGood Example
This document was produced for <span class="ishare-inline-edit">##purpose.INSERT RECIPIENT##</span>, please do not copy without permission.

Custom text input

As suggested by the "inline" part of the class name, the only form element used for text entry is the single-line <input> element, so no line-breaks can be added to the text.

...

The plugin will replace elements given particular class names with generated values.  As per user-editable elements, these must contain ##name.default content## tags, although the default content should always get replaced by dynamically generated text (if not, then something has gone wrong!).

IDValueNotes
mapMapRequired for template to load
legendLegend (when enabled in options)


ClassValueNotes
ishare-user
Current user and domainFormatted as: user@domain
ishare-timestamp
Current timeISO datetime format: e.g. 2018-03-23 14:37:39 
ishare-projection
The in-use map projection codeE.g.: EPSG:27700
ishare-attribution
Copyright taken from the base MapSource
ishare-scale
Current map scale
ishare-centre

ishare-centre-x
ishare-centre-y
Central co-ordinates of the current view of the map

Format for ishare-centre: x, y

Units are rounded to a number of decimal places dependent on the projection units: 5 for degrees; 3 for miles and kilometres; and 0 for everything else.

ishare-bbox

ishare-min-x
ishare-min-y
ishare-max-x
ishare-max-y
Corner co-ordinates of the current view of the map

Format for ishare-bbox: min-x min-y max-x max-y



See ishare-centre for rounding

Example

Code Block
languagexml
 				<div id="info">
                    <span id="title" class="ishare-edit-inline">##title.Enter map title##</span>
                    <p id="scale"><img src="images/NorthArrow.png" id="north" />Scale: <span class="ishare-scale">##scale.0##</span></p>
                    <p class="printinfo">Printed on: <span class="ishare-timestamp">##timestamp.1970-01-01##</span> by <span class="ishare-user">##user.user@domain##</span></p>
					<p class="printinfo">Projection: <span class="ishare-projection">##projection.Probably BNG##</span></p>
					<p class="printinfo">Attribution: <span class="ishare-attribution">##attribution.Probably OS##</span></p>
					<p class="printinfo">Centre: <span class="ishare-centre">##centre.0, 0##</span></p>
					<p class="printinfo">Centre X: <span class="ishare-centre-x">##centreX.0##</span></p>
					<p class="printinfo">Centre Y: <span class="ishare-centre-y">##centreY.0##</span></p>
					<p class="printinfo">Bounding box: <span class="ishare-bbox">##bbox.0 0 0 0##</span></p>
					<p class="printinfo">Minimum X: <span class="ishare-min-x">##minX.0##</span></p>
					<p class="printinfo">Minimum Y: <span class="ishare-min-y">##minY.0##</span></p>
					<p class="printinfo">Maximum X: <span class="ishare-max-x">##maxX.0##</span></p>
					<p class="printinfo">Maximum Y: <span class="ishare-max-y">##maxY.0##</span></p>
                </div><!-- info -->


Allowed Page Sizes