From e758bee77f58ec19941b0846f5a6fc2b1ce1a668 Mon Sep 17 00:00:00 2001 From: Sean Kilgore Date: Mon, 19 Mar 2012 23:55:06 -0700 Subject: [PATCH] Updated signs documentation, including genPOI.py usage. --- docs/signs.rst | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/docs/signs.rst b/docs/signs.rst index 1a2177f..62bc42e 100644 --- a/docs/signs.rst +++ b/docs/signs.rst @@ -42,7 +42,7 @@ A more advanced filter may also look at other entity fields, such as the sign te def goldFilter(poi): "Gold" return poi['id'] == 'Sign' and (\ - 'gold' in poi['Text1] or + 'gold' in poi['Text1'] or 'gold' in poi['Text2']) This looks for the word 'gold' in either the first or second line of the signtext. @@ -66,6 +66,32 @@ rendered map. For example:: + +Generating the POI Markers +========================== + +genPOI.py +--------- + +In order to actually generate the markers and add them to your map, the script +genPOI.py must be run. For example:: + + genpoi.py --config=/path/to/your/config.file + +.. note:: + Markers will not be updated or added during a regular overviewer.py + map render! + +This will generate the necessary JavaScript files needed in your config file's +outputdir. + +Options +------- + +genPOI.py has a single option:: --config. You should use the same configfile as +used for your normal renders. + + .. _predefined_filter_functions: Predefined Filter Functions