Differences

This shows you the differences between two versions of the page.

--- manual:advanced:customization:actions [2015/09/03 16:56] – mstupka
+++ manual:advanced:customization:actions [2025/11/19 20:35] (current) – [Event] menion
@@ Line 1: / Line 1: @@
 ====== Locus Actions ======
-This mysterious name hides a very simple way of providing an easy method of downloading data from your own web server to Locus Map (and probably other features will come later). The whole concept is based on XML file that you provide to Locus for processing. The XML file describes what to do.
+This mysterious name hides a very simple way of providing an easy method of downloading data from your own web server to Locus Map (and probably other features will come later). The whole concept is based on an XML file that you provide to Locus Map for processing. The XML file describes what to do.
+Locus Map currently supports only these actions:
+  * **download**
+  * **event**
-Locus Map currently supports only one action: **download**
-<todo> pokračovat : </todo>
 ===== How to =====
-Whole file you provide to Locus is XML file with this syntax
+The whole file you provide to Locus is an XML file with this syntax:
-  <?xml version="1.0" encoding="utf-8"?>
+<code>
-  <locusActions>
+<?xml version="1.0" encoding="utf-8"?>
-    <action>...</action>
+<locusActions>
-  </locusActions>
+  <action>...</action>
+</locusActions>
+</code>
-Where //locusActions// may contain one or more //action// objects, that will do required work.
+Where //locusActions// may contain one or more //action// objects that will do the required work.
-To make Locus correctly handling this file, you simply construct URL to this file by following syntax (example)
+To make Locus Map handle this file correctly, simply construct a URL to this file with the following syntax (example):
-  locus-actions://https/dl.dropbox.com/u/12579512/my_directory/test.xml
+<code>
+locus-actions://https/dl.dropbox.com/u/12579512/my_directory/test.xml
+</code>
-As you can see, simply change scheme to **locus-actions** and default scheme change to part of base URL separated only by one slash. Locus will handle this link in simple way:
+As you can see, changing simply the scheme to **locus-actions** and the default scheme changes to a part of the base URL separated only by one slash. Locus Map will simply handle this link:
-  - remove **locus-actions** tag
-  - change first part into new scheme
+  - removes **locus-actions**  tag
+  - changes the first part into a new scheme
 ==== Download ====
-Action object that serve to download files into Locus directory
+An action object that serves downloading files into the Locus directory.
-Sample syntax is
+Sample syntax is:
-  <?xml version="1.0" encoding="utf-8"?>
+<code>
-  <locusActions>
+<?xml version="1.0" encoding="utf-8"?>
-    <download>
+<locusActions>
-      <source size="22075830" date="2012-06-29_19-11-54">
+  <download>
-        <![CDATA[http://.../map.tar]]>
+    <source size="22075830" date="2012-06-29_19-11-54">
-      </source>
+      <![CDATA[http://.../map.tar]]>
-      <dest><![CDATA[/maps/map.tar]]></dest>
+    </source>
-      <after>...</after>
+    <dest><![CDATA[/maps/map.tar]]></dest>
-    </download>
+    <after>...</after>
-  </locusActions>
+  </download>
+</locusActions>
+</code>
 __Where__
-  * **download** - is core tag, that identify this action
-  * **source** - URL to source file. If contain **size** and **date** parameters, download file be checked and not downloaded if already exists
+  * **download**  - a core tag that identifies this action
-    * **size** - (optional) size of file in bytes
+  * **source**  - URL to source file. If it contains **size**  and **date**  parameters, the download file will be checked and not downloaded if it already exists.
-    * **date** - (optional) date of last edit in format //yyyy-MM-dd_HH-mm-ss//. Some phones have problems with setting correct time to downloaded file. Highly recommended is to set only **size** for comparing already downloaded files,
+      * **size**  - (optional) size of the file in bytes
-  * **dest** - relative path (to Locus root), where to put new file
+      * **date**  - (optional) date of the last edit of format //yyyy-MM-dd_HH-mm-ss//. Some phones have problems with setting the correct time for the downloaded file. It is highly recommended to set only **size**  for comparing already downloaded files.
-  * **after** - special action that is performed after download. Currently supported is
+  * **dest** - alternate path (to Locus root) where to put the new file
-    * **refreshMap** - useful if you download new personal or vector maps. This called on last map (in case you download more maps), refresh list of maps without need to restart Locus
+  * **after** - special action that is performed after download. Currently supported:
-    * **importData** - immediately after file is downloaded, Locus will start normal import process of this file
+      * **refreshMap**  - useful if you download a new personal or vector map. This calls on the last map (in case you download more maps) and refreshes the list of maps without the need to restart Locus
-    * **displayData** - immediately after download, Locus will load and display downloaded file on map. Data will be displayed only temporarily, so if you want to store them permanently, use //importData// option
+      * **importData**  - immediately after the file is downloaded, Locus Map starts the common import process of this file
-    * **extract** - extract downloaded file. Directory is the one, used for download.
+      * **displayData**  - immediately after download, Locus Map loads and displays the downloaded file on the map. Data will be displayed only temporarily, so if you want to store it permanently, use //importData// option instead
-    * **deleteSource** - allow to delete downloaded file. This is useful mainly if you download zipped file and after extract, you want to remove this file.
+      * **extract**  - extracts downloaded file. The directory is the same as for download.
+      * **deleteSource**  - allows deletion of the downloaded file. This is useful mainly if you download a zipped file, and after extracting it, you want to remove it.
 __TIPS__
-  * **Download map file (zip archive)** - you may use this combination **extract|deleteSource|refreshMap**, which extract file after download, delete original file and finally refresh maps list.
-  * **Download file ready for import (zip archive)** - you may use this combination **extract|importData**, which extract file after download and start import. In this case, it is suggested to set **dest** parameter to special Locus directory **cache/temp**. This directory is from time to time cleared, so all unneeded files will be removed.
+  * **Download map file (zip archive)**  - you may use this combination **extract|deleteSource|refreshMap**, which extracts the file after download, deletes the original file, and finally refreshes the maps list.
+  * **Download file ready for import (zip archive)**  - you may use this combination **extract|importData**, which extracts the file after download and starts import. In this case, it is suggested to set the **dest**  parameter to the special Locus Map directory **cache/temp**. This directory is cleared from time to time, so all unneeded files are removed.
+==== Event====
+An action that triggers a certain action.
+Sample syntax is:
+<code>
+<?xml version="1.0" encoding="utf-8"?>
+<locusActions>
+  <event>
+    <key>setMapVector</key>
+    <value><![CDATA[ /mapsVector/DownloadedMap.map ]]></value>
+  </event>
+</locusActions>
+</code>
+__Where__
+  * **key**  - one of predefined types
+      * __setMapVector__  - set a certain map file
+      * __setMapVectorTheme__  - set a certain map theme
+  * **value** - relative path to map or theme

knowledge base

User Tools

Site Tools

Differences