This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
manual:advanced:customization:actions [2015/09/03 16:56] – mstupka | manual:advanced:customization:actions [2015/10/23 10:15] (current) – mstupka | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Locus Actions ====== | ====== 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 XML file that you provide to Locus Map for processing. The XML file describes what to do. |
Locus Map currently supports only one action: **download** | Locus Map currently supports only one action: **download** | ||
- | < | ||
===== How to ===== | ===== How to ===== | ||
- | Whole file you provide to Locus is XML file with this syntax | + | Whole file you provide to Locus is an XML file with this syntax: |
- | | + | < |
- | < | + | <?xml version=" |
- | < | + | < |
- | </ | + | < |
+ | </ | ||
+ | </code> | ||
- | Where // | + | Where // |
- | To make Locus correctly handling | + | To make Locus Map handle |
- | | + | < |
+ | locus-actions:// | ||
+ | </ | ||
- | As you can see, simply | + | As you can see, change |
- | - remove | + | |
- | - change | + | - removes |
+ | - changes | ||
==== Download ==== | ==== Download ==== | ||
- | Action object that serve to download | + | Action object that serves downloading |
- | Sample syntax is | + | Sample syntax is: |
- | | + | < |
- | < | + | <?xml version=" |
- | < | + | < |
- | <source size=" | + | < |
- | < | + | <source size=" |
- | </ | + | < |
- | < | + | </ |
- | < | + | < |
- | </ | + | < |
- | </ | + | </ |
+ | </ | ||
+ | </code> | ||
__Where__ | __Where__ | ||
- | | + | |
- | * **source** - URL to source file. If contain | + | |
- | * **size** - (optional) size of file in bytes | + | * **source** |
- | * **date** - (optional) date of last edit in format // | + | * **size** |
- | * **dest** - relative | + | * **date** |
- | * **after** - special action that is performed after download. Currently | + | * **dest** - alternate |
- | * **refreshMap** - useful if you download new personal or vector | + | * **after** - special action that is performed after download. Currently is supported: |
- | * **importData** - immediately after file is downloaded, Locus will start normal | + | * **refreshMap** |
- | * **displayData** - immediately after download, Locus will load and display | + | * **importData** |
- | * **extract** - extract | + | * **displayData** |
- | * **deleteSource** - allow to delete downloaded file. This is useful mainly if you download zipped file and after extract, | + | * **extract** |
+ | * **deleteSource** | ||
__TIPS__ | __TIPS__ | ||
- | | + | |
- | * **Download file ready for import (zip archive)** - you may use this combination **extract|importData**, | + | |
+ | * **Download file ready for import (zip archive)** |