Disable all plugins in example config files

And better document those examples

Author: joto

config/experimental.lua

@@ -19,6 +19,10 @@ themepark:set_option('tags', 'all_tags') -- Add JSONB column `tags` with origina
 
 -- themepark:add_topic('core/clean-tags')
 
+-- ---------------------------------------------------------------------------
+-- Choose which names from which languages to use in the map.
+-- See 'themes/core/README.md' for details.
+
 -- themepark:add_topic('core/name-single', { column = 'name' })
 -- themepark:add_topic('core/name-list', { keys = {'name', 'name:de', 'name:en'} })
 
@@ -30,16 +34,20 @@ themepark:add_topic('core/name-with-fallback', {
     }
 })
 
---themepark:add_topic('experimental/builtup')
---themepark:add_topic('experimental/places')
---themepark:add_topic('experimental/rivers')
+-- ---------------------------------------------------------------------------
+
+-- themepark:add_topic('experimental/builtup')
+-- themepark:add_topic('experimental/places')
+-- themepark:add_topic('experimental/rivers')
 
 themepark:add_topic('core/elevation')
 themepark:add_topic('experimental/information')
 themepark:add_topic('experimental/viewpoints')
 
 -- ---------------------------------------------------------------------------
 
-themepark:plugin('t-rex'):write_config('t-rex-config.toml', {})
+-- Enable if you want to create a config file for the T-Rex tile server.
+--
+-- themepark:plugin('t-rex'):write_config('t-rex-config.toml', {})
 
 -- ---------------------------------------------------------------------------

config/shortbread.lua

@@ -14,6 +14,8 @@ themepark.debug = false
 themepark:set_option('tags', 'all_tags')
 
 -- ---------------------------------------------------------------------------
+-- Choose which names from which languages to use in the map.
+-- See 'themes/core/README.md' for details.
 
 -- themepark:add_topic('core/name-single', { column = 'name' })
 -- themepark:add_topic('core/name-list', { keys = {'name', 'name:de', 'name:en'} })
@@ -26,6 +28,8 @@ themepark:add_topic('core/name-with-fallback', {
     }
 })
 
+-- --------------------------------------------------------------------------
+
 themepark:add_topic('core/layer')
 
 themepark:add_topic('external/oceans', { name = 'ocean' })
@@ -52,13 +56,20 @@ themepark:add_topic('shortbread_v1/addresses')
 
 -- ---------------------------------------------------------------------------
 
+-- Create config files only in create mode, not when updating the database.
+-- This protects the file in case it contains manual edits.
 if osm2pgsql.mode == 'create' then
-    themepark:plugin('t-rex'):write_config('t-rex-config.toml', {
-        tileset = 'osm',
-    })
+-- Enable if you want to create a config file for the T-Rex tile server.
+--
+--    themepark:plugin('t-rex'):write_config('t-rex-config.toml', {})
 
+-- Enable if you want to create a config file for the Tilekiln tile server.
+-- (You must also create the directory 'tk'.)
+--
 --    themepark:plugin('tilekiln'):write_config('tk')
 
+-- Enable if you want to create a taginfo project file.
+--
 --    themepark:plugin('taginfo'):write_config('taginfo-shortbread', {
 --        project = { name = 'shortbread' }
 --    })

config/shortbread_gen.lua

@@ -18,6 +18,8 @@ themepark:set_option('tags', 'all_tags')
 themepark:set_option('unique_id', 'id')
 
 -- ---------------------------------------------------------------------------
+-- Choose which names from which languages to use in the map.
+-- See 'themes/core/README.md' for details.
 
 -- themepark:add_topic('core/name-single', { column = 'name' })
 -- themepark:add_topic('core/name-list', { keys = {'name', 'name:de', 'name:en'} })
@@ -30,6 +32,8 @@ themepark:add_topic('core/name-with-fallback', {
     }
 })
 
+-- --------------------------------------------------------------------------
+
 themepark:add_topic('core/layer')
 
 themepark:add_topic('external/oceans', { name = 'ocean' })
@@ -56,37 +60,44 @@ themepark:add_topic('shortbread_v1/addresses')
 
 -- ---------------------------------------------------------------------------
 
+-- Create config files only in create mode, not when updating the database.
+-- This protects the file in case it contains manual edits.
 if osm2pgsql.mode == 'create' then
-    themepark:plugin('t-rex'):write_config('t-rex-config.toml', {
-        tileset = 'osm',
-        extra_layers = {
-            {
-                buffer_size = 10,
-                name = 'street_labels',
-                geometry_type = 'LINESTRING',
-                query = {
-                    {
-                        minzoom = 14,
-                        sql = [[
-SELECT "name","name_de","name_en","kind","layer","ref","ref_rows","ref_cols","z_order","geom"
-    FROM "streets"
-    WHERE "geom" && !bbox! AND !zoom! >= "minzoom"
-    ORDER BY "z_order" asc]]
-                    },
-                    {
-                        minzoom = 11,
-                        maxzoom = 13,
-                        sql = [[
-SELECT "name","name_de","name_en","kind","layer","ref","ref_rows","ref_cols","z_order","geom"
-    FROM "streets_med"
-    WHERE "geom" && !bbox! AND !zoom! >= "minzoom"
-    ORDER BY "z_order" asc]]
-                    },
-                }
-            }
-        }
-    })
+-- Enable if you want to create a config file for the T-Rex tile server
+--
+--     themepark:plugin('t-rex'):write_config('t-rex-config.toml', {
+--         tileset = 'osm',
+--         extra_layers = {
+--             {
+--                 buffer_size = 10,
+--                 name = 'street_labels',
+--                 geometry_type = 'LINESTRING',
+--                 query = {
+--                     {
+--                         minzoom = 14,
+--                         sql = [[
+-- SELECT "name","name_de","name_en","kind","layer","ref","ref_rows","ref_cols","z_order","geom"
+--     FROM "streets"
+--     WHERE "geom" && !bbox! AND !zoom! >= "minzoom"
+--     ORDER BY "z_order" asc]]
+--                     },
+--                     {
+--                         minzoom = 11,
+--                         maxzoom = 13,
+--                         sql = [[
+-- SELECT "name","name_de","name_en","kind","layer","ref","ref_rows","ref_cols","z_order","geom"
+--     FROM "streets_med"
+--     WHERE "geom" && !bbox! AND !zoom! >= "minzoom"
+--     ORDER BY "z_order" asc]]
+--                     },
+--                 }
+--             }
+--         }
+--     })
 
+-- Enable if you want to create a config file for the Tilekiln tile server.
+-- (You must also create the directory 'tk'.)
+--
 --    themepark:plugin('tilekiln'):write_config('tk')
 end