User Tools

Site Tools


manual:advanced:customization:actions

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
manual:advanced:customization:actions [2015/10/23 10:08]
mstupka [Locus Actions]
manual:advanced:customization:actions [2015/10/23 10:15] (current)
mstupka
Line 15: Line 15:
 </code> </code>
  
-Where //locusActions// may contain one or more //action// objectsthat will do required work.+Where //locusActions// may contain one or more //action// objects that will do the required work.
  
 To make Locus Map handle this file correctly, simply construct URL to this file by following syntax (example): To make Locus Map handle this file correctly, simply construct URL to this file by following syntax (example):
Line 23: Line 23:
 </code> </code>
  
-As you can see, simply change the scheme to **locus-actions** and the default scheme changes to part of base URL separated only by one slash. Locus will handle this link in simple way:+As you can see, change simply the scheme to **locus-actions** and the default scheme changes to part of base URL separated only by one slash. Locus Map will handle this link in simple way:
  
   - removes **locus-actions**  tag   - removes **locus-actions**  tag
Line 49: Line 49:
 __Where__ __Where__
  
-  * **download**  - a core tagthat identifies this action +  * **download**  - a core tag that identifies this action 
-  * **source**  - URL to source file. If it contains **size**  and **date**  parameters, download file will be checked and not downloaded if it already exists+  * **source**  - URL to source file. If it contains **size**  and **date**  parameters, download file will be checked and not downloaded if it already exists.
       * **size**  - (optional) size of the file in bytes       * **size**  - (optional) size of the file in bytes
-      * **date**  - (optional) date of the last edit of format //yyyy-MM-dd_HH-mm-ss//. Some phones have problems with setting correct time to the downloaded file. Highly recommended is to set only **size**  for comparing already downloaded files +      * **date**  - (optional) date of the last edit of format //yyyy-MM-dd_HH-mm-ss//. Some phones have problems with setting correct time to the downloaded file. Highly recommended is to set only **size**  for comparing already downloaded files. 
-  * **dest** - alternate path (to Locus root)where to put the new file +  * **dest** - alternate path (to Locus root) where to put the new file 
-  * **after** - special action that is performed after download. Currently is supported +  * **after** - special action that is performed after download. Currently is supported: 
-      * **refreshMap**  - useful if you download a new personal or vector maps. This calls on the last map (in case you download more maps) and refreshes list of maps without need to restart Locus+      * **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 need to restart Locus
       * **importData**  - immediately after the file is downloaded Locus Map starts common import process of this file       * **importData**  - immediately after the file is downloaded Locus Map starts common import process of this file
       * **displayData**  - immediately after download Locus Map loads and displays downloaded file on map. Data will be displayed only temporarily, so if you want to store them permanently, use //importData// option instead       * **displayData**  - immediately after download Locus Map loads and displays downloaded file on map. Data will be displayed only temporarily, so if you want to store them permanently, use //importData// option instead
Line 63: Line 63:
 __TIPS__ __TIPS__
  
-  * **Download map file (zip archive)**  - you may use this combination **extract|deleteSource|refreshMap**, which extracts file after download, deletes original file and finally refreshes the maps list. +  * **Download map file (zip archive)**  - you may use this combination **extract|deleteSource|refreshMap**, which extracts the file after download, deletes original file and finally refreshes the maps list. 
-  * **Download file ready for import (zip archive)**  - you may use this combination **extract|importData**, which extracts file after download and starts import. In this case, it is suggested to set **dest**  parameter to special Locus Map directory **cache/temp**. This directory is cleared from time to time so all unneeded files are removed.+  * **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 **dest**  parameter to special Locus Map directory **cache/temp**. This directory is cleared from time to time so all unneeded files are removed.
  
manual/advanced/customization/actions.txt · Last modified: 2015/10/23 10:15 by mstupka