Polygon definitions - Revision history

4523550: /* Historical data */ Description of new function.

2024-04-27T13:01:08Z

Historical data: Description of new function.

← Older revision		Revision as of 13:01, 27 April 2024
Line 167:		Line 167:

	== Historical data ==		== Historical data ==
	Historical definitions exists in the database ~~but~~ can ~~not yet~~ be ~~viewed on~~ the ~~web~~. ~~If they are needed due~~ to ~~mistakenly destroying complex definitions we can retrieve them fairly easily~~.		Historical definitions exists in the database and can be fetched with the restore-tool at the bottom of each page. Selecting an old definition in the drop down loads the old definition in the tool, to use the old definition it needs to be saved.

	==Notes==		==Notes==

3305483: Added other options that weren't documented.

2022-04-19T20:30:24Z

Added other options that weren't documented.

← Older revision		Revision as of 20:30, 19 April 2022
Line 47:		Line 47:
	The best way to add rules is by using the ''Add rule'' button on the right side of the input form. This will help you keeping the syntax correct. All values that are defined as either 0 (zero) or empty strings ("") are required to fill in. Keys that has empty lists as values are optional.		The best way to add rules is by using the ''Add rule'' button on the right side of the input form. This will help you keeping the syntax correct. All values that are defined as either 0 (zero) or empty strings ("") are required to fill in. Keys that has empty lists as values are optional.

	There are ~~four~~ types of rules that can be used to import polygons, and they should be listed under the key ''polygons''. The rules are used by setting type to the ID of the rule, and then defining at least the required keys.		There are several types of rules that can be used to import polygons, and they should be listed under the key ''polygons''. The rules are used by setting type to the ID of the rule, and then defining at least the required keys.
	* '''adminLevel''' - This is the easiest and most common way to. In a perfect world this would be the only rule needed. Basically it includes everything with a specified ''adminLevel'' under a ''parentOsmId''.		* '''adminLevel''' - This is the easiest and most common way to. In a perfect world this would be the only rule needed. Basically it includes everything with a specified ''adminLevel'' under a ''parentOsmId''.
	** Required keys		** Required keys
Line 58:		Line 58:
	*** '''allowNonAdministrative''' - By default the system requires that OSM's tag ''boundary'' is set to ''administrative''. If this is not wished for, set this to true (do not quote it).		*** '''allowNonAdministrative''' - By default the system requires that OSM's tag ''boundary'' is set to ''administrative''. If this is not wished for, set this to true (do not quote it).
	*** '''db''' - Override the base database.		*** '''db''' - Override the base database.
			* '''immediateChildrenOf''' - Add all immediate children of this osmb-id, regardless of the admin-level.
			** Required keys
			*** '''parentOsmId''' - OSM ID from [[OSM-boundaries.com]].
			** Optional keys
			*** '''boundary''' - Require the OSM tag boundary to be set to this string value, for example ''administrative''.
			*** '''db''' - Override the base OSMB database.
			*** '''excludeOsmIds''' - Exclude these IDs. A list with IDs as shown on [[OSM-Boundaries.com]].
	* '''osmIds''' - This rule allows adding a list of OSM-IDs as regions.		* '''osmIds''' - This rule allows adding a list of OSM-IDs as regions.
	** Required keys		** Required keys
Line 102:		Line 109:
	** Required keys		** Required keys
	*** '''maxValue'''		*** '''maxValue'''
			* '''convertCase''' - Convert the casing using PHPs mb_convert_case() function, using the mode specified in the require mode option.
			** Required keys
			*** '''mode''' - Valid modes are: MB_CASE_UPPER, MB_CASE_LOWER, MB_CASE_TITLE, MB_CASE_FOLD, MB_CASE_UPPER_SIMPLE, MB_CASE_LOWER_SIMPLE, MB_CASE_TITLE_SIMPLE, MB_CASE_FOLD_SIMPLE.

	Each rule can be repeated as many times as needed. Every rule can also include the optional key '''comment'''. It can be used to document why that specific rule exists, or why a specific osmId is subtracted for example.		Each rule can be repeated as many times as needed. Every rule can also include the optional key '''comment'''. It can be used to document why that specific rule exists, or why a specific osmId is subtracted for example.

3305483: Removed obsolete reference

2022-04-19T20:23:13Z

Removed obsolete reference

← Older revision		Revision as of 20:23, 19 April 2022
Line 27:		Line 27:

	=== Country rules ===		=== Country rules ===
	All countries '''must''' be defined in [[Project-GC]]. This is primarily used when rendering maps for [[Profile stats]], and the maps would look a bit funny if a country was missing.~~<ref>Only true for the upcoming maps of Profile stats.</ref>~~		All countries '''must''' be defined in [[Project-GC]]. This is primarily used when rendering maps for [[Profile stats]], and the maps would look a bit funny if a country was missing.

	The country rules are the simplest. There is no post-processing of names and there are only two types of rules available.		The country rules are the simplest. There is no post-processing of names and there are only two types of rules available.

3305483: Adding some basic information about the type file

2022-04-19T20:21:47Z

Adding some basic information about the type file

← Older revision		Revision as of 20:21, 19 April 2022
Line 47:		Line 47:
	The best way to add rules is by using the ''Add rule'' button on the right side of the input form. This will help you keeping the syntax correct. All values that are defined as either 0 (zero) or empty strings ("") are required to fill in. Keys that has empty lists as values are optional.		The best way to add rules is by using the ''Add rule'' button on the right side of the input form. This will help you keeping the syntax correct. All values that are defined as either 0 (zero) or empty strings ("") are required to fill in. Keys that has empty lists as values are optional.

	There are ~~three~~ types of rules that can be used to import polygons, and they should be listed under the key ''polygons''. The rules are used by setting type to the ID of the rule, and then defining at least the required keys.		There are four types of rules that can be used to import polygons, and they should be listed under the key ''polygons''. The rules are used by setting type to the ID of the rule, and then defining at least the required keys.
	* '''adminLevel''' - This is the easiest and most common way to. In a perfect world this would be the only rule needed. Basically it includes everything with a specified ''adminLevel'' under a ''parentOsmId''.		* '''adminLevel''' - This is the easiest and most common way to. In a perfect world this would be the only rule needed. Basically it includes everything with a specified ''adminLevel'' under a ''parentOsmId''.
	** Required keys		** Required keys
Line 63:		Line 63:
	** Optional keys		** Optional keys
	*** '''subtractOsmIds''' - Subtract polygons from the ones that are being imported. If possible, try to split the rule into two rules, where only those needing the subtract are listed together with the subtract. And those not needing subtraction for themself. This will increase the import performance a lot.		*** '''subtractOsmIds''' - Subtract polygons from the ones that are being imported. If possible, try to split the rule into two rules, where only those needing the subtract are listed together with the subtract. And those not needing subtraction for themself. This will increase the import performance a lot.
			*** '''fillHoles''' - Boolean, if true all holes inside the polygon will be filled as if there were no holes. If it was used on Sweden there would be no Vättern och Vänern for example.
	*** '''db''' - Override the base database.		*** '''db''' - Override the base database.
	* '''union''' - If there aren't polygons available that works, but there are other polygons which could be joined together to create what's needed this rule-type can be used. Required keys		* '''union''' - If there aren't polygons available that works, but there are other polygons which could be joined together to create what's needed this rule-type can be used. Required keys
Line 68:		Line 69:
	** Optional keys		** Optional keys
	*** '''subtractOsmIds'''		*** '''subtractOsmIds'''
			*** '''fillHoles''' - Boolean, if true all holes inside the polygon will be filled as if there were no holes. If it was used on Sweden there would be no Vättern och Vänern for example.
	*** '''db''' - Override the base database.		*** '''db''' - Override the base database.
			* '''file''' - This is a a special case option that shouldn't be used in general. But for Canada it has been used. Basically it uses stored geojson files instead of [[OSM-Boundaries.com]] as a source. Canada actually is a mix of Openstreetmap and Census data.
			** Required keys
			*** '''filename'''
			*** '''propertyKey'''
			** Optional keys
			*** '''propertyValue'''
			*** '''name'''
			*** '''fillHoles''' - Boolean, if true all holes inside the polygon will be filled as if there were no holes. If it was used on Sweden there would be no Vättern och Vänern for example.

	Then there are a number of rules for post-processing names as well. Since they are executed in the order they are listed the order might be important.		Then there are a number of rules for post-processing names as well. Since they are executed in the order they are listed the order might be important.

3305483: Various grammar and syntax updates. DB option added. Removed Ignore DB and added Base DB

2022-04-19T20:14:51Z

Various grammar and syntax updates. DB option added. Removed Ignore DB and added Base DB

← Older revision		Revision as of 20:14, 19 April 2022
Line 1:		Line 1:

	== Page description ==		== Page description ==
	This is an admin/moderator page to which only specific users have access. The page is used to create rules used when importing polygon data from OpenStreetMap into [[Project-GC]]. The data is then used for calculations regarding placing [[geocache]]s in their correct region/county. The data is also used for rendering maps, as for example the maps in [[Profile stats]].		This is an admin/moderator page to which only specific users have access. The page is used to create rules used when importing polygon data from OpenStreetMap into [[Project-GC]]. More precisely, Project-GC imports from [[OSM-Boundaries.com]], which in turn has imported its data from OpenStreetMap. The data is then used for calculations regarding placing [[geocache]]s in their correct region/county. The data is also used for rendering maps, as for example the maps in [[Profile stats]].

	== Country selector ==		== Country selector ==
Line 12:		Line 12:

	== Source site ==		== Source site ==
	[[Project-GC]] uses [[OSM-Boundaries.com]] as a source when importing its polygon data. This site is also a great source to use when building the import rules.		[[Project-GC]] uses [[OSM-Boundaries.com]] as a source when importing its polygon data. This site is also a great source to use when building the import rules. [[OSM-Boundaries.com]] in turn has imported its data from data dumps of OpenStreetMap.

	== Rules ==		== Rules ==
Line 19:		Line 19:
	The rule-set for countries differs a bit from regions/counties, the reason is that a country should always end with a single (multi)polygon, while regions and counties needs one (multi)polygon per region/county.		The rule-set for countries differs a bit from regions/counties, the reason is that a country should always end with a single (multi)polygon, while regions and counties needs one (multi)polygon per region/county.

	All import rules are created as JSON-strings. Generally it ~~exists~~ of a list of rules for the polygons itself, and the a list of rules for post-processing names. When the import tool runs it will first run all rules under ''polygons'', and then the rules under ''postprocessing''. Each rule is executed in the order it's listed as.		All import rules are created as JSON-strings. Generally it consists of a list of rules for the polygons itself, and the a list of rules for post-processing names. When the import tool runs it will first run all rules under ''polygons'', and then the rules under ''postprocessing''. Each rule within these two is executed in the order it's listed as.

	You can look at already defined definitions to get an overall understanding how the definitions should look.		You can look at already defined definitions to get an overall understanding how the definitions should look.

	=== ~~Ignore databases~~ ===		=== Base OSMB Database ===
	If the OSM ~~data is known to~~ be ~~broken in~~ a ~~specific database version they~~ can be ~~blacklisted with this option~~.		This is the OSM-Boundaries database version that will be used as a basis for this country's polygon import. It can then be overridden for specific rules later on. It's not always using the latest since all data must be reviewed, it's not uncommon that OpenStreetMap has brooken or incompatible data. A typical use-case for overriding is when Openstreetmap has broken data.

	~~Just write~~ the ~~name of the database in the input field. If multiple database names are needed, separate them by commas. Use white-space at your own disposal, they will~~ be ~~ignored.~~

	~~The input field is currently limited to 128 bytes. There is no technical reason to this~~, it's ~~more~~ that ~~the string will become unreadable the longer it gets~~.

	=== Country rules ===		=== Country rules ===
	All countries '''must''' be defined in [[Project-GC]]. This is primarily used when rendering maps for [[Profile stats]], ~~but they~~ would look a bit funny if a country was missing.<ref>Only true for the upcoming maps of Profile stats.</ref>		All countries '''must''' be defined in [[Project-GC]]. This is primarily used when rendering maps for [[Profile stats]], and the maps would look a bit funny if a country was missing.<ref>Only true for the upcoming maps of Profile stats.</ref>

	The country rules are the simplest. There is no post-processing of names and there are only types of rules available.		The country rules are the simplest. There is no post-processing of names and there are only two types of rules available.
	* '''includeOsmIds''' - List of integer IDs from [[OSM-Boundaries.com]]. These are IDs of polygons that will be included in the country.		* '''includeOsmIds''' - List of integer IDs from [[OSM-Boundaries.com]]. These are IDs of polygons that will be included in the country.
	* '''subtractOsmIds''' - List of integer IDs from [[OSM-Boundaries.com]]. The IDs listed here will be subtracted from the includeOsmIds. For example in the case of Finland, the ID of Finland can be chosen as the country and then Aland Island can be subtracted.		* '''subtractOsmIds''' - List of integer IDs from [[OSM-Boundaries.com]]. The IDs listed here will be subtracted from the includeOsmIds. For example in the case of Finland, the ID of Finland can be chosen as the country and then Aland Island can be subtracted.

			Each rule can also use the '''db''' attribute to specify another database than the ''base'' one.

	Rather use one big polygon as include and a few subtract than a lot of includes. For example, USA either requires including the whole USA and then subtracting 3-5 polygons, or making a list of ~50 polygons for inclusion. There are two good reasons to rather include the whole country and then make a few subtracts.		Rather use one big polygon as include and a few subtract than a lot of includes. For example, USA either requires including the whole USA and then subtracting 3-5 polygons, or making a list of ~50 polygons for inclusion. There are two good reasons to rather include the whole country and then make a few subtracts.
Line 59:		Line 57:
	*** '''subtractOsmIds''' - Subtract polygons listed here. This is a lot slower than ''excludeParentOsmIds'' and should only be used when we actually need to punch a whole into something.		*** '''subtractOsmIds''' - Subtract polygons listed here. This is a lot slower than ''excludeParentOsmIds'' and should only be used when we actually need to punch a whole into something.
	*** '''allowNonAdministrative''' - By default the system requires that OSM's tag ''boundary'' is set to ''administrative''. If this is not wished for, set this to true (do not quote it).		*** '''allowNonAdministrative''' - By default the system requires that OSM's tag ''boundary'' is set to ''administrative''. If this is not wished for, set this to true (do not quote it).
			*** '''db''' - Override the base database.
	* '''osmIds''' - This rule allows adding a list of OSM-IDs as regions.		* '''osmIds''' - This rule allows adding a list of OSM-IDs as regions.
	** Required keys		** Required keys
Line 64:		Line 63:
	** Optional keys		** Optional keys
	*** '''subtractOsmIds''' - Subtract polygons from the ones that are being imported. If possible, try to split the rule into two rules, where only those needing the subtract are listed together with the subtract. And those not needing subtraction for themself. This will increase the import performance a lot.		*** '''subtractOsmIds''' - Subtract polygons from the ones that are being imported. If possible, try to split the rule into two rules, where only those needing the subtract are listed together with the subtract. And those not needing subtraction for themself. This will increase the import performance a lot.
	* '''union''' - If there aren't polygons available that works, but there are other polygons which could be joined together to create what's needed this rule-type can be used. ** Required keys		*** '''db''' - Override the base database.
			* '''union''' - If there aren't polygons available that works, but there are other polygons which could be joined together to create what's needed this rule-type can be used. Required keys
	*** '''osmIds''' - List of osmIds		*** '''osmIds''' - List of osmIds
	** Optional keys		** Optional keys
	*** '''subtractOsmIds'''		*** '''subtractOsmIds'''
			*** '''db''' - Override the base database.

	Then there are a number of rules for post-processing names as well. Since they are executed in the order ~~specified~~ the order might be important.		Then there are a number of rules for post-processing names as well. Since they are executed in the order they are listed the order might be important.
	* '''renameOsmId'''		* '''renameOsmId'''
	** Required keys		** Required keys
Line 92:		Line 93:
	*** '''maxValue'''		*** '''maxValue'''

	Each rule can be repeated as many times as needed. Every rule can also include the optional key '''comment'''. It can be used to ~~documenting~~ why that specific rule exists, or why a specific osmId is subtracted for example.		Each rule can be repeated as many times as needed. Every rule can also include the optional key '''comment'''. It can be used to document why that specific rule exists, or why a specific osmId is subtracted for example.

	Finally there is an option that can be set on the same level as ''polygons'' and ''postprocessing''		Finally there is an option that can be set on the same level as ''polygons'' and ''postprocessing''

4523550: Temporary section removed.

2021-05-19T18:49:17Z

Temporary section removed.

@@ Line 147: / Line 147: @@
 == Historical data ==
 Historical definitions exists in the database but can not yet be viewed on the web. If they are needed due to mistakenly destroying complex definitions we can retrieve them fairly easily.
 ==Notes==

3305483: removeMultiByteAbove

2021-03-12T13:30:23Z

removeMultiByteAbove

← Older revision		Revision as of 13:30, 12 March 2021
Line 69:		Line 69:
	*** '''subtractOsmIds'''		*** '''subtractOsmIds'''

	Then there are ~~three types~~ of rules for post-processing names as well. Since they are executed in the order specified the order might be important.		Then there are a number of rules for post-processing names as well. Since they are executed in the order specified the order might be important.
	* '''renameOsmId'''		* '''renameOsmId'''
	** Required keys		** Required keys
Line 88:		Line 88:
	*** '''regionName'''		*** '''regionName'''
	*** '''suffix'''		*** '''suffix'''
			* '''removeMultiByteAbove''' - Will remove all characters in the string that has an utf8 value higher than ''maxValue''. Be aware that there might be some left-overs like dash after this rule has been run. Running a ''removeSuffix'' afterwards can help with that.
			** Required keys
			*** '''maxValue'''

	Each rule can be repeated as many times as needed. Every rule can also include the optional key '''comment'''. It can be used to documenting why that specific rule exists, or why a specific osmId is subtracted for example.		Each rule can be repeated as many times as needed. Every rule can also include the optional key '''comment'''. It can be used to documenting why that specific rule exists, or why a specific osmId is subtracted for example.

3305483: Cleanup of rules

2021-03-11T14:11:51Z

Cleanup of rules

← Older revision		Revision as of 14:11, 11 March 2021
Line 51:		Line 51:
	There are three types of rules that can be used to import polygons, and they should be listed under the key ''polygons''. The rules are used by setting type to the ID of the rule, and then defining at least the required keys.		There are three types of rules that can be used to import polygons, and they should be listed under the key ''polygons''. The rules are used by setting type to the ID of the rule, and then defining at least the required keys.
	* '''adminLevel''' - This is the easiest and most common way to. In a perfect world this would be the only rule needed. Basically it includes everything with a specified ''adminLevel'' under a ''parentOsmId''.		* '''adminLevel''' - This is the easiest and most common way to. In a perfect world this would be the only rule needed. Basically it includes everything with a specified ''adminLevel'' under a ''parentOsmId''.
	** Required ~~parameters:~~		** Required keys
	*** '''parentOsmId'''		*** '''parentOsmId'''
	*** '''adminLevel'''		*** '''adminLevel'''
	** Optional ~~parameters~~		** Optional keys
	*** '''excludeOsmIds''' - Exclude specific ''osmIds'' even though they match the ''parentOsmId'' and the ''adminLevel''.		*** '''excludeOsmIds''' - Exclude specific ''osmIds'' even though they match the ''parentOsmId'' and the ''adminLevel''.
	*** '''excludeParentOsmIds''' - Exclude anything that has these ''osmIds'' as a parent in OSM-Boundaries tree-view.		*** '''excludeParentOsmIds''' - Exclude anything that has these ''osmIds'' as a parent in OSM-Boundaries tree-view.
	*** '''subtractOsmIds''' - Subtract polygons listed here. This is a lot slower than ''excludeParentOsmIds'' and should only be used when we actually need to punch a whole into something.		*** '''subtractOsmIds''' - Subtract polygons listed here. This is a lot slower than ''excludeParentOsmIds'' and should only be used when we actually need to punch a whole into something.
	*** '''allowNonAdministrative''' - By default the system requires that OSM's tag ''boundary'' is set to ''administrative''. If this is not wished for, set this to true (do not quote it).		*** '''allowNonAdministrative''' - By default the system requires that OSM's tag ''boundary'' is set to ''administrative''. If this is not wished for, set this to true (do not quote it).
	* '''osmIds''' - This rule allows adding a list of OSM-IDs as regions. ''~~excludeOsmIds~~'' ~~wouldn~~'~~t make sense to use here, the osmId should then just not be included in the first place.~~ '''subtractOsmIds''' ~~is an optional key~~ that~~'s available though~~.		* '''osmIds''' - This rule allows adding a list of OSM-IDs as regions.
	* '''union''' - If there aren't polygons available that works, but there are other polygons which could be joined together to create what's needed this rule-type can be used. Required keys ~~are '''name''' and~~ '''osmIds'''~~. The later being a list~~ of ~~OSM-IDs. The key~~ '''subtractOsmIds''' ~~is also available for optional use.~~		** Required keys
			*** '''osmIds''' - List of osmIds
			** Optional keys
			*** '''subtractOsmIds''' - Subtract polygons from the ones that are being imported. If possible, try to split the rule into two rules, where only those needing the subtract are listed together with the subtract. And those not needing subtraction for themself. This will increase the import performance a lot.
			* '''union''' - If there aren't polygons available that works, but there are other polygons which could be joined together to create what's needed this rule-type can be used. ** Required keys
			*** '''osmIds''' - List of osmIds
			** Optional keys
			*** '''subtractOsmIds'''

	Then there are three types of rules for post-processing names as well. Since they are executed in the order specified the order might be important.		Then there are three types of rules for post-processing names as well. Since they are executed in the order specified the order might be important.
	* '''renameOsmId''' - Required keys: '''osmId''' ~~(OSM-ID) and~~ '''name''' ~~(string).~~		* '''renameOsmId'''
	* '''removePrefixes''' - Required ~~key:~~ '''prefixes''' ~~(list~~ of strings).		** Required keys
	* '''removeSuffixes''' - Required ~~key:~~ '''suffixes''' ~~(list~~ of strings).		*** '''osmId'''
			*** '''name'''
			* '''removePrefixes'''
			** Required keys
			*** '''prefixes''' - List of strings.
			* '''removeSuffixes'''
			** Required keys
			*** '''suffixes''' - List of strings.
			* '''prefixToSuffix'''
			** Required keys
			*** '''prefix'''
			*** '''suffix''' - Don't forget to start with a space character if wished for.
			* '''suffixBasedOnRegionName'''
			** Required keys
			*** '''regionName'''
			*** '''suffix'''

	Each rule can be repeated as many times as needed. Every rule can also include the optional key '''comment'''. It can be used to documenting why that specific rule exists, or why a specific osmId is subtracted for example.		Each rule can be repeated as many times as needed. Every rule can also include the optional key '''comment'''. It can be used to documenting why that specific rule exists, or why a specific osmId is subtracted for example.
Line 101:		Line 123:
	{ "type": "renameOsmId", "osmId": -54409, "name": "Scania" },		{ "type": "renameOsmId", "osmId": -54409, "name": "Scania" },
	{ "type": "removePrefixes", "prefixes": ["foo"] },		{ "type": "removePrefixes", "prefixes": ["foo"] },
	{ "type": "removeSuffixes", "suffixes": ["bar"] }		{ "type": "removeSuffixes", "suffixes": ["bar"] },
			{ "type": "prefixToSuffix", "prefix": "Landkreis", "suffix": " (Lkr)" },
			{ "type": "suffixBasedOnRegionName", "regionName": "California", "suffix": " (Ca)" }
	]		]
	}		}

3305483: Updated rules

2021-03-11T13:40:02Z

Updated rules

← Older revision		Revision as of 13:40, 11 March 2021
Line 50:		Line 50:

	There are three types of rules that can be used to import polygons, and they should be listed under the key ''polygons''. The rules are used by setting type to the ID of the rule, and then defining at least the required keys.		There are three types of rules that can be used to import polygons, and they should be listed under the key ''polygons''. The rules are used by setting type to the ID of the rule, and then defining at least the required keys.
	* '''adminLevel''' - This is the easiest and most common way to. In a perfect world this would be the only rule needed. Basically it includes everything with a specified '''adminLevel''' under a '''parentOsmId'''~~. Other optional keys are~~ '''excludeOsmIds''', '''~~subtractOsmIds~~''' and '''~~allowNonAdministrative~~'''. ''~~excludeOsmIds~~'' ~~will simply ignore the fact~~ that ~~the~~ ''~~adminLevel~~'' ~~matched the rule~~. ''subtractOsmIds'' ~~can~~ be used to ~~actually calculate the difference between those polygons included and the subtracted ones~~. ''allowNonAdministrative'' ~~defaults to false, which~~ requires ~~the~~ OSM boundary ~~value to be~~ set to ''administrative''~~, if other polygons are~~ wished for, set this to true.		* '''adminLevel''' - This is the easiest and most common way to. In a perfect world this would be the only rule needed. Basically it includes everything with a specified ''adminLevel'' under a ''parentOsmId''.
			** Required parameters:
			*** '''parentOsmId'''
			*** '''adminLevel'''
			** Optional parameters
			*** '''excludeOsmIds''' - Exclude specific ''osmIds'' even though they match the ''parentOsmId'' and the ''adminLevel''.
			*** '''excludeParentOsmIds''' - Exclude anything that has these ''osmIds'' as a parent in OSM-Boundaries tree-view.
			*** '''subtractOsmIds''' - Subtract polygons listed here. This is a lot slower than ''excludeParentOsmIds'' and should only be used when we actually need to punch a whole into something.
			*** '''allowNonAdministrative''' - By default the system requires that OSM's tag ''boundary'' is set to ''administrative''. If this is not wished for, set this to true (do not quote it).
	* '''osmIds''' - This rule allows adding a list of OSM-IDs as regions. ''excludeOsmIds'' wouldn't make sense to use here, the osmId should then just not be included in the first place. '''subtractOsmIds''' is an optional key that's available though.		* '''osmIds''' - This rule allows adding a list of OSM-IDs as regions. ''excludeOsmIds'' wouldn't make sense to use here, the osmId should then just not be included in the first place. '''subtractOsmIds''' is an optional key that's available though.
	* '''union''' - If there aren't polygons available that works, but there are other polygons which could be joined together to create what's needed this rule-type can be used. Required keys are '''name''' and '''osmIds'''. The later being a list of OSM-IDs. The key '''subtractOsmIds''' is also available for optional use.		* '''union''' - If there aren't polygons available that works, but there are other polygons which could be joined together to create what's needed this rule-type can be used. Required keys are '''name''' and '''osmIds'''. The later being a list of OSM-IDs. The key '''subtractOsmIds''' is also available for optional use.

3305483: Documented parameter allowNonAdministrative for rule adminLevel

2021-03-11T12:08:07Z

Documented parameter allowNonAdministrative for rule adminLevel

← Older revision		Revision as of 12:08, 11 March 2021
Line 50:		Line 50:

	There are three types of rules that can be used to import polygons, and they should be listed under the key ''polygons''. The rules are used by setting type to the ID of the rule, and then defining at least the required keys.		There are three types of rules that can be used to import polygons, and they should be listed under the key ''polygons''. The rules are used by setting type to the ID of the rule, and then defining at least the required keys.
	* '''adminLevel''' - This is the easiest and most common way to. In a perfect world this would be the only rule needed. Basically it includes everything with a specified '''adminLevel''' under a '''parentOsmId'''. Other optional keys are '''excludeOsmIds''' and '''~~subtractOsmIds~~'''. ''excludeOsmIds'' will simply ignore the fact that the ''adminLevel'' matched the rule. ''subtractOsmIds'' can be used to actually calculate the difference between those polygons included and the subtracted ones.		* '''adminLevel''' - This is the easiest and most common way to. In a perfect world this would be the only rule needed. Basically it includes everything with a specified '''adminLevel''' under a '''parentOsmId'''. Other optional keys are '''excludeOsmIds''', '''subtractOsmIds''' and '''allowNonAdministrative'''. ''excludeOsmIds'' will simply ignore the fact that the ''adminLevel'' matched the rule. ''subtractOsmIds'' can be used to actually calculate the difference between those polygons included and the subtracted ones. ''allowNonAdministrative'' defaults to false, which requires the OSM boundary value to be set to ''administrative'', if other polygons are wished for, set this to true.
	* '''osmIds''' - This rule allows adding a list of OSM-IDs as regions. ''excludeOsmIds'' wouldn't make sense to use here, the osmId should then just not be included in the first place. '''subtractOsmIds''' is an optional key that's available though.		* '''osmIds''' - This rule allows adding a list of OSM-IDs as regions. ''excludeOsmIds'' wouldn't make sense to use here, the osmId should then just not be included in the first place. '''subtractOsmIds''' is an optional key that's available though.
	* '''union''' - If there aren't polygons available that works, but there are other polygons which could be joined together to create what's needed this rule-type can be used. Required keys are '''name''' and '''osmIds'''. The later being a list of OSM-IDs. The key '''subtractOsmIds''' is also available for optional use.		* '''union''' - If there aren't polygons available that works, but there are other polygons which could be joined together to create what's needed this rule-type can be used. Required keys are '''name''' and '''osmIds'''. The later being a list of OSM-IDs. The key '''subtractOsmIds''' is also available for optional use.