Module:Russo-Ukrainian War detailed map/doc

For quick reference, this module is transcluded on the following:

 * Template:Russo-Ukrainian War detailed map
 * Template:Russo-Ukrainian War detailed relief map
 * Template:Russo-Ukrainian War detailed map (oblasts)
 * Template:Russo-Ukrainian War detailed relief map (oblasts)

Icons available for use on map
Control:  Ukraine    Russia and allies (Donetsk People's Republic & Luhansk People's Republic)

Stable mixed control (same colours):     Uncontrolled: Rural presence: Contested:  Russia/Ukraine Besieged one side:

Besieged: 2 nested circles: inner controls, outer sieges (or indicates strong enemy pressure): Military base: Abm-blue-icon.png Abm-red-icon.png Strategic hill: Map-peak-blue.svg Map-peak-red.svg Oil/gas: Gota03.svg Gota01.svg Airport/air base (plane): Fighter-jet-blue-icon.svg Fighter-jet-red-icon.svg Heliport/helicopter base: Helicopter-blue-icon.svg Helicopter-red-icon.svg Major port or naval base: Anchor_pictogram_blue.svg Anchor_pictogram_red.svg Industrial complex: Icon NuclearPowerPlant-blue.svg Icon NuclearPowerPlant-red.svg Border post: Mountain pass 12x12 n.svg  Dam: Arch dam 12x12 w.svg Small icon within a larger icon: the situation in individual neighbourhood/district

Labels
Only towns & border posts can have blue visible wikilink labels. Whether a town has a blue visible wikilink label or not will depend on its size, importance and available space around it for the label to appear without obstructing other towns.

Definition
The purpose of the contested icon is to show 2 groups of soldiers fighting over control of a town, and that there is a significant number of troops inside the city actively holding territory. We generally turn a town contested based on widespread clashes reports. Contested means we cannot say one specific side controls the town. There should be evidence that the enemy is inside the town, which is a necessary (but not sufficient) condition for making a town contested. Contested status is appropriate if the town in question is controlled partly by one party, and partly by another. For example, it could be that one party controls the outer neighborhoods, while the other party holds the city center.

Examples of cases where the contested icon should not be used

 * Cases where there have been only small or sporadic clashes in a town, or clashes that stopped after some hours.
 * A case where there were reports of ambushes on army checkpoints, but no seizure of territory inside the town.
 * A case where the enemy reached city limits. Well, they still haven't entered the city proper (which is the prerequisite for marking the city as "contested") When the city really becomes contested, a bunch of news outlets will be reporting on it. Just because there is enemy at gates does not mean it is contested. The enemy needs to be making progress in the city.
 * The evidence should be especially strong to turn a “stronghold” contested. A few clashes, especially on the periphery are not enough. There should be evidence that the enemy can do more than just hit & run attacks. In these cases, a semi-circle is often enough.

Cities
The larger the size of the town, the more evidence is needed to make it contested. This is even more so the case for cities. Large cities (such as province capitals) are almost never marked as contested. Instead we make image mini-maps for them or put small icons on them to represent neighborhoods that are contested or controlled by a specific party. In contrast, a simple clash report of a small unknown village can turn it contested.

For example, we would not mark as contested a city where a party still controls 95% of the city. Instead we mark specific enemy positions on the outskirts of the city until fighting in the city becomes widespread. As nobody claims there is any fighting inside of the city, it should be marked as colored dot within a siege circle (see Figure 1). Then, advanced points in the city should be marked as small dots in the color of the enemy (or small contested icons). In this specific case, a "contested" icon was added to represent the "west side of the city" that is contested (see Figure 2). This is more informative to our viewers. Since the code puts icons on the map in the order of code lines (starting with first line of code and ending with last line of code), the small "contested" icon should come in the line after that of the (large) city icon. Otherwise, the small icon will be hidden by the large icon and will therefore be invisible.

After the fights become more widespread in the city (& enemy controls a larger part of the city), we can remove the "west side of the city" icon and turn the whole city contested (see Figure 3). After this, if we learn that the enemy has taken over the whole city except for a small pocket (in south east) that is still resisting, then we change the contested icon into the color of the enemy and put a small dot representing the small pocket that is still resisting (see Figure 4).

Definition
The siege icon should be used for towns that are under siege or enemy pressure or militant attacks or rocket attacks. The “pressure from one side” icon should be used for towns that are under enemy pressure from one side.

How to place these icons
The easiest way to place these icons is to copy/paste the line code of the object you want to have a circle (or semi-circle) around it and then:
 * 1) Replace the mark = parameter with map-circle-blue.svg or map-arcNE-blue.svg
 * 2) Increase marksize = parameter by 4. So for example, if the town dot has a size of 10, then the circle (or semi-circle) should have a size of 14.

Always put line of code circle (or semi-circle) before line of code of town (or other object). This is because the code puts icons on the map in the order of code lines starting with first line of code and ending with last line of code. If you put the line of code that draws the circle (or semi-circle) icon after the line of code that draws the town icon then the computer puts the town icon first and then put the circle (or semi-circle) icon on top of it. The town icon still appears because the circle (or semi-circle) is drawn on a transparent background. However, even a transparent background does obstruct the name of the town icon from appearing. So, the name of the town will not appear when you hold cursor over it.

Example:
 * Correct:
 * Wrong:

Truce (purple) icon
The purple icon should be used for towns where the party in question has lost a significant amount of sovereignty, such as giving up heavy weapons, allowing regular enemy patrols inside of it, etc… If all that the “truce” means is that there is no fighting or shooting from both parties, then there is no need for a purple icon. In summary, the purple icon means loss of sovereignty, not lack of fighting.

"link=" parameter: linking towns to sources
Every element on the map should be verifiable. Information on towns (description of control & sources) can be found by clicking on the town dot on the map. Notice the caption of the map which says: "Hold cursor over location to display name; click to go to sources &/or status description (if available, the cursor will show as ; if not, it will show as )."

Notice the “link=” parameter in the map code. This is supposed to link to the part in the Wikipedia article that contains the source and talks about the events in the town. So for example, if you click on the dot of the town "Inkhil" on the map, it will take you to the part of the Wikipedia article on the town "Inkhil" that has the description of war events (& sources): link = "Inkhil" Here the first part before the # is the name of the article (Inkhil). the second part after the # is the name of the section (civilwar).

For this to work, there needs to be a section by this same name in the article or you need to put a wikilink anchor:   that will act as a section header (in this case  ).

The link to sources &/or status description should be done according to the following priorities in this order: A quick look at the map's code will tell you where each town dot is currently linking.
 * 1) The part of the town's article that talks about the war events in the town (see Example 1 below).
 * 2) The part of a "battle/offensive/etc..." article that talks about the latest status of the specific town (see Example 2 below).
 * 3) The article about the town which does not contain war events (still better than nothing).

Example 1: How to keep town dots linked to the latest status source when the town has its own Wikipedia article.. The example concerns the town of Al-Taybah. First, notice how there is: link = "Al-Taybah" parameter associated with the code line of town Al-Taybah. As indicated above, this links the Al-Taybah town dot with the war section in the town's Wikipedia article. This parameter does not change over time. However, the war section in the town's Wikipedia article needs to stay up-to-date in terms of the latest control status and latest associated source. For example, on 20/08/2017 the government took the town. To keep the link up-to-date, this latest event (along with the source) needs to be added to the war section in the town's Wikipedia article. To accomplish this, notice the following edit which added to the article the following text:

However, in 20/08/2017, the Army stormed the Taybah area from their positions at the Al-Kom axis, pushing their way through ISIL's front-lines. Unable to maintain their positions, ISIL was forced to retreat from Taybah, leaving the entire area for the Army to take control of after a short battle.

This provides the latest status (along with the source) to viewers clicking on the town's dot in the map. Notice also how at the beginning of the war section in the town's Wikipedia article, there is the expression:. This mirrors the #civilwar part in the link parameter in the map's code and allows the click on the dot to take the viewer to the beginning of the war section in the town's Wikipedia article. In summary, when the status of a map object changes, the color of the icon has to be updated and the write-up (along with the source) has to be added as well.

Example 2: How to keep town dots linked to the latest status source when the town does not have its own Wikipedia article. The example concerns the town of "Kabajeb". Up to August 2017, the link parameter associated with the code line of the town was link= "Deir ez-Zor offensive (April–July 2014)#Kabajeb". As indicated above, this links the Kabajeb town dot with a war article that talks about the latest war events concerning the town (along with a source). This was done because the town Kabajeb does not have its own Wikipedia article. Therefore, the link is made to the article that have the latest status & source. In this case, it is the article Deir ez-Zor offensive (April–July 2014) which states in its code:

The ISIS reportedly took parts of the town,

Notice how the paragraph starts with the expression  . This guides the link to put the reader exactly at the beginning of the latest status & source. However, on 2017-09-04, the government took the town from ISIS. So the above link & source is no longer up-to-date. To stay up-to-date, you need to do 2 steps:

Step 1: Write about the new status in some "battle/offensive/etc..." article that relates to the town. Alternatively, you can find an up-to-date text that someone else wrote and proceed to the next step. In our case, you find that someone wrote this updated status in the article Central Syria campaign (July 2017–present) which states in its code:

5th Corps alongside 18th Reserve Division captured the town of Kabajib during midday, while later in the day together with Tiger Forces captured al-Shulah.

This is exactly what we need. Therefore, we proceed to the next step.

Step 2: In the map code, we need to update the link parameter to point to the new status in the new article. This edit does this. As you can see, the link was changed from link="Deir ez-Zor offensive (April–July 2014)" to link="Central Syria campaign (July 2017–present)". However, for this to work, we need to also put the expression at the beginning of the part in the new article that talks about the new status. This is done in this edit.

Example 3: For another illustration on how the link= parameter and "anchor" template work, see Talk:Cities and towns during the Syrian Civil War/Archive 65.

How to preview map before saving edit
Before saving your changes (by clicking "Publish changes"), you should preview your edits (changes). This allows you to view the map to make sure it is what you want to do before saving and making the change appear on Wikipedia. To do this, type in the box under "Preview page with this module" the name of the template: "Template:Russo-Ukrainian War detailed map". Then hit "Show preview".