Merge pull request #4351 from wesnoth/special_notes

Update to new special notes syntax in campaigns

data/campaigns/Dead_Water/units/Brawler.cfg

@@ -14,7 +14,8 @@
     alignment=lawful
     cost=19
     usage=fighter
-    description= _ "Exceptionally large and strong mermen are sometimes more comfortable with their own fists and tails than with other weapons."+{SPECIAL_NOTES}+{SPECIAL_NOTES_STUN}
+    description= _ "Exceptionally large and strong mermen are sometimes more comfortable with their own fists and tails than with other weapons."
+	{NOTE_STUN}
     die_sound=mermen-die.ogg
     {DEFENSE_ANIM "units/merfolk/brawler-defend.png" "units/merfolk/brawler-defend.png" mermen-hit.wav }
     [attack]

data/campaigns/Dead_Water/units/Kraken.cfg

@@ -21,7 +21,9 @@
     cost=62
     undead_variation=swimmer
     usage=fighter
-    description= _ "Krakens are gigantic creatures of the seas. They can grab their opponents with strong tentacles, or spit a poisonous black ink from a distance. The best way to survive an encounter with these monsters is to remain ashore."+{SPECIAL_NOTES}+{SPECIAL_NOTES_POISON}+{SPECIAL_NOTES_SWARM}
+    description= _ "Krakens are gigantic creatures of the seas. They can grab their opponents with strong tentacles, or spit a poisonous black ink from a distance. The best way to survive an encounter with these monsters is to remain ashore."
+    {NOTE_POISON}
+    {NOTE_SWARM}
     die_sound=water-blast.wav
     {DEFENSE_ANIM_DIRECTIONAL_RANGE "units/monsters/kraken-defend.png" "units/monsters/kraken.png" "units/monsters/kraken-n-defend.png" "units/monsters/kraken-n-tentacle-1.png" squishy-hit.wav melee}
     {DEFENSE_ANIM_DIRECTIONAL_RANGE "units/monsters/kraken-defend.png" "units/monsters/kraken.png" "units/monsters/kraken-defend.png" "units/monsters/kraken.png" squishy-hit.wav ranged}

data/campaigns/Dead_Water/units/Soldier_King.cfg

@@ -17,7 +17,8 @@
     [abilities]
         {ABILITY_LEADERSHIP}
     [/abilities]
-    description= _ "A king who is skilled at combat commands great respect — especially among soldiers. His strength allows him to wield powerful weapons and move quickly, even with heavy armor. His leadership abilities inspire his troops."+{SPECIAL_NOTES}+{SPECIAL_NOTES_LEADERSHIP}
+    description= _ "A king who is skilled at combat commands great respect — especially among soldiers. His strength allows him to wield powerful weapons and move quickly, even with heavy armor. His leadership abilities inspire his troops."
+	{NOTE_LEADERSHIP}
     die_sound=mermen-die.ogg
     {DEFENSE_ANIM "units/merfolk/soldier_king.png" "units/merfolk/soldier_king.png" mermen-hit.wav }
     [resistance]

data/campaigns/Dead_Water/units/Warrior_King.cfg

@@ -17,7 +17,8 @@
     [abilities]
         {ABILITY_LEADERSHIP}
     [/abilities]
-    description= _ "Warrior kings often become legendary in their own time. Their skill and strength allows them to be truly formidable in battle. They are also fast despite their heavy armor. Even skilled soldiers look upon them with awe."+{SPECIAL_NOTES}+{SPECIAL_NOTES_LEADERSHIP}
+    description= _ "Warrior kings often become legendary in their own time. Their skill and strength allows them to be truly formidable in battle. They are also fast despite their heavy armor. Even skilled soldiers look upon them with awe."
+	{NOTE_LEADERSHIP}
     die_sound=mermen-die.ogg
     {DEFENSE_ANIM "units/merfolk/warrior_king.png" "units/merfolk/warrior_king.png" mermen-hit.wav }
     [resistance]

data/campaigns/Dead_Water/units/Young_King.cfg

@@ -17,7 +17,8 @@
     [abilities]
         {ABILITY_LEADERSHIP}
     [/abilities]
-    description= _ "A young king with some battle experience will be treated with some respect. Common citizens will be inspired to do their utmost when the king is nearby, but battle-hardened veterens will be less impressed."+{SPECIAL_NOTES}+{SPECIAL_NOTES_LEADERSHIP}
+    description= _ "A young king with some battle experience will be treated with some respect. Common citizens will be inspired to do their utmost when the king is nearby, but battle-hardened veterens will be less impressed."
+	{NOTE_LEADERSHIP}
     die_sound=mermen-die.ogg
     {DEFENSE_ANIM "units/merfolk/young_king.png" "units/merfolk/young_king.png" mermen-hit.wav }
     [attack]

data/campaigns/Dead_Water/utils/specials.cfg

@@ -1,8 +1,10 @@
 #textdomain wesnoth-dw
 
-#define SPECIAL_NOTES_STUN
-_ "
-• This unit is able to stun its enemies, disrupting their zones of control."#enddef
+#define NOTE_STUN
+[special_note]
+    note=_ "This unit is able to stun its enemies, disrupting their zones of control."
+[/special_note]
+#enddef
 
 #define WEAPON_SPECIAL_STUN
     [damage]

data/campaigns/Delfadors_Memoirs/units/Journeyman_Mage.cfg

@@ -9,5 +9,6 @@
     alignment=neutral		# Rather than lawful
     cost=25			# A little more expensive
     advances_to=Mage Leader
-    description=_"A mage who has just finished his apprenticeship is known as a journeyman. Journeyman mages travel far in search of employment and experience."+{SPECIAL_NOTES}+{SPECIAL_NOTES_MAGICAL}
+    description=_"A mage who has just finished his apprenticeship is known as a journeyman. Journeyman mages travel far in search of employment and experience."
+	{NOTE_MAGICAL}
 [/unit_type]

data/campaigns/Delfadors_Memoirs/units/King_of_Wesnoth.cfg

@@ -12,5 +12,6 @@
     experience=250
     level=5
     cost=200
-    description=_"Under the feudal system, all authority ultimately rested with the sovereign. His lords held their property only with his agreement, and had to pay him tribute. In return, the king would defend the realm against invaders, and redistribute wealth in times of need."+{SPECIAL_NOTES}+{SPECIAL_NOTES_LEADERSHIP}
+    description=_"Under the feudal system, all authority ultimately rested with the sovereign. His lords held their property only with his agreement, and had to pay him tribute. In return, the king would defend the realm against invaders, and redistribute wealth in times of need."
+	{NOTE_LEADERSHIP}
 [/unit_type]

data/campaigns/Delfadors_Memoirs/units/Mage_Commander.cfg

@@ -13,7 +13,10 @@
     movement=6			# A little faster
     advances_to=Mage Magister
     cost=100			# A lot more expensive
-    description=_"This mage has gained much experience leading others into battle. As a result, level 1 and 2 units fight more effectively when they are adjacent to him. He also has the power to heal others during combat."+{SPECIAL_NOTES}+{SPECIAL_NOTES_MAGICAL}+{SPECIAL_NOTES_LEADERSHIP}+{SPECIAL_NOTES_HEALS}
+    description=_"This mage has gained much experience leading others into battle. As a result, level 1 and 2 units fight more effectively when they are adjacent to him. He also has the power to heal others during combat."
+	{NOTE_MAGICAL}
+    {NOTE_LEADERSHIP}
+    {NOTE_HEALS}
     [attack]
         icon=attacks/staff-magic.png
         name=staff

data/campaigns/Delfadors_Memoirs/units/Mage_Leader.cfg

@@ -12,7 +12,9 @@
     experience=100	# Same as base unit
     advances_to=Mage Commander
     cost=60		# Considerably more expensive
-    description=_"This mage has gained some experience leading others into battle. As a result, level 1 units fight more effectively when they are adjacent to him." +{SPECIAL_NOTES}+{SPECIAL_NOTES_MAGICAL}+{SPECIAL_NOTES_LEADERSHIP}
+    description=_"This mage has gained some experience leading others into battle. As a result, level 1 units fight more effectively when they are adjacent to him." 
+	{NOTE_MAGICAL}
+    {NOTE_LEADERSHIP}
     [attack]
         name=staff
         #textdomain wesnoth-units

data/campaigns/Delfadors_Memoirs/units/Mage_Magister.cfg

@@ -15,7 +15,10 @@
     [/resistance]
     movement=6			# A little faster
     cost=125			# Rather more expensive
-    description=_"A Mage Magister, though equivalent in degree to a Great Mage, has special abilities of command and healing derived from extensive experience of battle."+{SPECIAL_NOTES}+{SPECIAL_NOTES_MAGICAL}+{SPECIAL_NOTES_LEADERSHIP}+{SPECIAL_NOTES_HEALS}
+    description=_"A Mage Magister, though equivalent in degree to a Great Mage, has special abilities of command and healing derived from extensive experience of battle."
+	{NOTE_MAGICAL}
+	{NOTE_LEADERSHIP}
+	{NOTE_HEALS}
     [attack]
         icon=attacks/staff-magic.png
         name=staff

data/campaigns/Descent_Into_Darkness/units/Apprentice_Mage.cfg

@@ -14,7 +14,8 @@
     advances_to=Apprentice Necromancer
     cost=15
     usage=mixed fighter
-    description=_ "Trained in swordsmanship as a boy and the magical arts as a young man, Malin Keshar is talented at both but an expert in neither. Although not as powerful as other fighters in direct combat, Malin’s sharp wit often allows him to outsmart his foes without putting himself in much danger."+{SPECIAL_NOTES}+{SPECIAL_NOTES_MAGICAL}
+    description=_ "Trained in swordsmanship as a boy and the magical arts as a young man, Malin Keshar is talented at both but an expert in neither. Although not as powerful as other fighters in direct combat, Malin’s sharp wit often allows him to outsmart his foes without putting himself in much danger."
+	{NOTE_MAGICAL}
     {DEFENSE_ANIM "units/apprentice-mage-defend.png" "units/apprentice-mage-sword.png" {SOUND_LIST:HUMAN_HIT} }
     die_sound={SOUND_LIST:HUMAN_DIE}
     [attack]

data/campaigns/Descent_Into_Darkness/units/Apprentice_Necromancer.cfg

@@ -13,7 +13,9 @@
     advances_to=Dark Mage
     gender=male
     usage=mixed fighter
-    description=_ "Under Darken Volk’s tutelage, Malin has become adept at wielding necromancy both as a tool to raise an army of undead, and as a means to increase his own, personal power. Malin’s focus on improving his magical prowess has left little time for him to improve his swordsmanship, but he still holds on to his short sword as his melee weapon of choice."+{SPECIAL_NOTES}+{SPECIAL_NOTES_MAGICAL}+{SPECIAL_NOTES_ARCANE}
+    description=_ "Under Darken Volk’s tutelage, Malin has become adept at wielding necromancy both as a tool to raise an army of undead, and as a means to increase his own, personal power. Malin’s focus on improving his magical prowess has left little time for him to improve his swordsmanship, but he still holds on to his short sword as his melee weapon of choice."
+	{NOTE_MAGICAL}
+    {NOTE_ARCANE}
     {DEFENSE_ANIM "units/apprentice-necromancer-defend.png" "units/apprentice-necromancer.png" {SOUND_LIST:HUMAN_HIT} }
     die_sound={SOUND_LIST:HUMAN_DIE}
     [attack]

data/campaigns/Descent_Into_Darkness/units/Dark_Mage.cfg

@@ -14,7 +14,9 @@
     {AMLA_DEFAULT}
     cost=50
     usage=mixed fighter
-    description= _ "Although Malin’s sword has grown rusty from lack of proper care, he continues to use it for melee combat, perhaps more as a keepsake than an effective weapon. His increasing skill with magic, however, is more than enough to compensate."+{SPECIAL_NOTES}+{SPECIAL_NOTES_MAGICAL}+{SPECIAL_NOTES_ARCANE}
+    description= _ "Although Malin’s sword has grown rusty from lack of proper care, he continues to use it for melee combat, perhaps more as a keepsake than an effective weapon. His increasing skill with magic, however, is more than enough to compensate."
+	{NOTE_MAGICAL}
+    {NOTE_ARCANE}
     die_sound={SOUND_LIST:HUMAN_DIE}
     {DEFENSE_ANIM "units/dark-mage-defend.png" "units/dark-mage.png" {SOUND_LIST:HUMAN_HIT} }
     [attack]

data/campaigns/Descent_Into_Darkness/units/Frontier_Baroness.cfg

@@ -20,7 +20,8 @@
         {ABILITY_SKIRMISHER}
     [/abilities]
     usage=mixed fighter
-    description= _ "At Wesnoth’s frontiers, all able-bodied men and women must be able to defend their homes in times of need. Men are most often trained in the use of sword or bow and are used as soldiers who withstand the brunt of orcish assaults to hold the raiders at bay. Women, instead, learn to use the staff and sling and are most effective as scouts and ambushers. The most proficient are powerful skirmishers and are highly adept at reconnaissance, allowing them to often outmaneuver and entrap orcish raiders."+{SPECIAL_NOTES}+{SPECIAL_NOTES_SKIRMISHER}
+    description= _ "At Wesnoth’s frontiers, all able-bodied men and women must be able to defend their homes in times of need. Men are most often trained in the use of sword or bow and are used as soldiers who withstand the brunt of orcish assaults to hold the raiders at bay. Women, instead, learn to use the staff and sling and are most effective as scouts and ambushers. The most proficient are powerful skirmishers and are highly adept at reconnaissance, allowing them to often outmaneuver and entrap orcish raiders."
+	{NOTE_SKIRMISHER}
     die_sound={SOUND_LIST:HUMAN_FEMALE_DIE}
     [defend]
         hits=miss

data/campaigns/Eastern_Invasion/units/Bone_Knight.cfg

@@ -24,7 +24,8 @@
     {AMLA_DEFAULT}
     cost=35
     usage=scout
-    description= _ "Once great warriors across the plains, these mounted riders atop their skeletal horses were raised from the ground by unholy magic to spread fear and destruction."+{SPECIAL_NOTES}+{SPECIAL_NOTES_CHARGE}
+    description= _ "Once great warriors across the plains, these mounted riders atop their skeletal horses were raised from the ground by unholy magic to spread fear and destruction."
+	{NOTE_CHARGE}
     die_sound=skeleton-big-die.ogg
     [attack]
         name=axe

data/campaigns/Eastern_Invasion/units/Skeleton_Rider.cfg

@@ -30,7 +30,8 @@
     advances_to=Bone Knight
     cost=19
     usage=scout
-    description= _ "Once great warriors thundering across the plains, these mounted riders atop their skeletal horses were raised from the grave by unholy magic to spread fear and destruction."+{SPECIAL_NOTES}+{SPECIAL_NOTES_SUBMERGE}
+    description= _ "Once great warriors thundering across the plains, these mounted riders atop their skeletal horses were raised from the grave by unholy magic to spread fear and destruction."
+	{NOTE_SUBMERGE}
     die_sound={SOUND_LIST:SKELETON_DIE}
     [abilities]
         {ABILITY_SUBMERGE}

data/campaigns/Heir_To_The_Throne/units/Battle_Princess.cfg

@@ -25,7 +25,9 @@
         {ABILITY_INITIATIVE}
     [/abilities]
     usage=fighter
-    description= _ "A noble by birth, the Princess has learnt swordplay with the greatest generals and battle tactics with the greatest sages, making her both a great combatant and a leader. Now battle-hardened and strong of will, she can aid those around her in the art of combat."+{SPECIAL_NOTES}+{SPECIAL_NOTES_LEADERSHIP}+{SPECIAL_NOTES_INITIATIVE}
+    description= _ "A noble by birth, the Princess has learnt swordplay with the greatest generals and battle tactics with the greatest sages, making her both a great combatant and a leader. Now battle-hardened and strong of will, she can aid those around her in the art of combat."
+	{NOTE_LEADERSHIP}
+	{NOTE_INITIATIVE}
     die_sound={SOUND_LIST:HUMAN_FEMALE_DIE}
     [attack]
         name=sword
@@ -120,7 +122,10 @@
             {ABILITY_INITIATIVE}
         [/abilities]
         usage=fighter
-        description= _ "A noble by birth, the Princess has learnt swordplay with the greatest generals and battle tactics with the greatest sages, making her both a great combatant and a leader. Now battle-hardened and strong of will, she can aid those around her in the art of combat."{SPECIAL_NOTES}+{SPECIAL_NOTES_LEADERSHIP}+{SPECIAL_NOTES_INITIATIVE}+{SPECIAL_NOTES_MAGICAL}
+        description= _ "A noble by birth, the Princess has learnt swordplay with the greatest generals and battle tactics with the greatest sages, making her both a great combatant and a leader. Now battle-hardened and strong of will, she can aid those around her in the art of combat."{SPECIAL_NOTES}
+	    {NOTE_LEADERSHIP}
+	    {NOTE_INITIATIVE}
+	    {NOTE_MAGICAL}
         die_sound={SOUND_LIST:HUMAN_FEMALE_DIE}
         [attack]
             name=sword

data/campaigns/Heir_To_The_Throne/units/Commander.cfg

@@ -92,7 +92,8 @@
             image="units/konrad-commander-leading.png:300"
         [/frame]
     [/leading_anim]
-    description= _ "The rank of Commander is held by those who lead battle groups into combat. Possessing leadership skills, they give lower-level units in adjacent hexes improved performance in combat. Commanders are best skilled with the sword, although they also carry a bow to use when necessary. If the Commander is lost, so is the battle."{SPECIAL_NOTES}+{SPECIAL_NOTES_LEADERSHIP}
+    description= _ "The rank of Commander is held by those who lead battle groups into combat. Possessing leadership skills, they give lower-level units in adjacent hexes improved performance in combat. Commanders are best skilled with the sword, although they also carry a bow to use when necessary. If the Commander is lost, so is the battle."{SPECIAL_NOTES}
+	{NOTE_LEADERSHIP}
     {DEFENSE_ANIM_RANGE "units/konrad-commander-bow-defend.png" "units/konrad-commander-bow.png" {SOUND_LIST:HUMAN_HIT} ranged}
 
     [variation]
@@ -101,7 +102,9 @@
         hide_help=yes
         cost=60
         {LEADING_ANIM "units/konrad-commander-scepter-leading.png" "units/konrad-commander-scepter.png" 17,-22}
-        description= _ "The rank of Commander is held by those who lead battle groups into combat. Possessing leadership skills, they give lower-level units in adjacent hexes improved performance in combat. Commanders are best skilled with the sword, although they also carry a bow to use when necessary. If the Commander is lost, so is the battle."+{SPECIAL_NOTES}+{SPECIAL_NOTES_LEADERSHIP}+{SPECIAL_NOTES_MAGICAL}
+        description= _ "The rank of Commander is held by those who lead battle groups into combat. Possessing leadership skills, they give lower-level units in adjacent hexes improved performance in combat. Commanders are best skilled with the sword, although they also carry a bow to use when necessary. If the Commander is lost, so is the battle."
+	    {NOTE_LEADERSHIP}
+	    {NOTE_MAGICAL}
         [attack]
             name=sceptre of fire
             # the sceptre of fire always has the 're' writing, this is intentional!

data/campaigns/Heir_To_The_Throne/units/Dark_Queen.cfg

@@ -16,7 +16,8 @@
     {AMLA_DEFAULT}
     cost=35
     usage=fighter
-    description= _ "The evil queen Asheviere has terrorized Wesnoth for many years. Her knowledge of magic makes her a worthy foe in combat, although her power is mostly derived from those she commands."+{SPECIAL_NOTES}+{SPECIAL_NOTES_MAGICAL}
+    description= _ "The evil queen Asheviere has terrorized Wesnoth for many years. Her knowledge of magic makes her a worthy foe in combat, although her power is mostly derived from those she commands."
+	{NOTE_MAGICAL}
     die_sound={SOUND_LIST:HUMAN_FEMALE_DIE}
     {DEFENSE_ANIM "units/human-queen-defend2.png" "units/human-queen-defend1.png" {SOUND_LIST:HUMAN_FEMALE_HIT} }
     [attack]

data/campaigns/Heir_To_The_Throne/units/Fighter.cfg

@@ -57,7 +57,8 @@
         variation_id=sceptre
         hide_help=yes
         cost=38
-        description= _ "Young and brash, Fighters attack with a sword, and are vulnerable to more seasoned enemies. However, they have the potential to become great warriors one day."+{SPECIAL_NOTES}+{SPECIAL_NOTES_MAGICAL}
+        description= _ "Young and brash, Fighters attack with a sword, and are vulnerable to more seasoned enemies. However, they have the potential to become great warriors one day."
+        {NOTE_MAGICAL}
         [attack]
             name=sceptre of fire
             # the sceptre of fire always has the 're' writing, this is intentional!

data/campaigns/Heir_To_The_Throne/units/Lord.cfg

@@ -106,15 +106,18 @@
             image="units/konrad-lord-leading.png:300"
         [/frame]
     [/leading_anim]
-    description= _ "The noble leaders of many troops, Lords are especially strong in melee combat, and also possess skill with the bow. Like Commanders, Lords possess leadership skills, and improve the fighting ability of all adjacent lower-level units."+{SPECIAL_NOTES}+{SPECIAL_NOTES_LEADERSHIP}
+    description= _ "The noble leaders of many troops, Lords are especially strong in melee combat, and also possess skill with the bow. Like Commanders, Lords possess leadership skills, and improve the fighting ability of all adjacent lower-level units."
+	{NOTE_LEADERSHIP}
     {DEFENSE_ANIM_RANGE "units/konrad-lord-bow-defend.png" "units/konrad-lord-bow.png" {SOUND_LIST:HUMAN_HIT} ranged}
     [variation]
         {HTTT_LORD -scepter}
         variation_id=sceptre
         hide_help=yes
         cost=85
         {LEADING_ANIM "units/konrad-lord-scepter-leading.png" "units/konrad-lord-scepter.png" -16,-21}
-        description= _ "The noble leaders of many troops, Lords are especially strong in melee combat, and also possess skill with the bow. Like Commanders, Lords possess leadership skills, and improve the fighting ability of all adjacent lower-level units."+{SPECIAL_NOTES}+{SPECIAL_NOTES_LEADERSHIP}+{SPECIAL_NOTES_MAGICAL}
+        description= _ "The noble leaders of many troops, Lords are especially strong in melee combat, and also possess skill with the bow. Like Commanders, Lords possess leadership skills, and improve the fighting ability of all adjacent lower-level units."
+		{NOTE_LEADERSHIP}
+	    {NOTE_MAGICAL}
         {DEFENSE_ANIM_FILTERED "units/konrad-lord-scepter-defend.png" "units/konrad-lord-scepter.png" {SOUND_LIST:HUMAN_HIT} (
             [filter_second_attack]
                 name=sceptre of fire