Modul:Sportdata/dok

Detta är en hjälpmodul som innehåller funktioner som används av flera andra moduler, som :

• Modul:Sportperson WD
• Modul:Sportklubb WD
• Modul:Sportserie WD
• Modul:Medaljörer WD

För att använda funktionerna behöver du skriva require( 'Modul:Sportdata') i modulen som använder funktionerna. Modulen utnyttjar själv modulerna Modul:Sportdata localisation (för att underlätta översättning till andra språk ligger alla textsträngar som är språkberoende här), Modul:Sportdata rankings (ranking för olika idrottstävlingar för att t.ex. prioritera VM & OS högre än spel i lägre divisionerna i den nationella ligan) samt Modul:Referenshantering (för att visa referenser).

Funktioner

isClub

• Syfte: Avgöra om en entitet är en klubb (till skillnad från ett landslag)
• Returnerar: sant/falskt
• Argument:
  • id – id (Q följt av ett nummer, som t.ex. 'Q3149147') för för det objekt som du vill testa ifall den är en klubb (t.ex. Imoco Volley (Q3149147))
  • txtProperty – den egenskap som du vill använda för utvärderingen. Ska sättas till 'P31' (instans av (P31)) vid anrop (däremot anropar funktionen sig själv med underklass till (P279))
• Vad funktionen gör: funktionen loopar igenom alla värden för objektets instans av (P31).
  • Om landslag (Q1194951) returnerar den falskt.
  • Om idrottsförening (Q847017), idrottslag (Q12973014), volleybollklubb (Q108395614) eller multisportklubb (Q13580678) returnerar den sant
  • Om den har något annat värde anropar den funktionen sig själv för att undersöka om värdet är en underklass till (P279) till något av de ovanstående.

isNationalTeam

• Syfte: Avgöra om en entitet är ett landslag (till skillnad från en klubb)
• Returnerar: sant/falskt
• Argument:
  • id – id (Q följt av ett nummer, som t.ex. 'Q3873841') för det objekt som du vill testa ifall den är ett landslag (t.ex. Sveriges damlandslag i volleyboll (Q3873841))
  • txtProperty – den egenskap som du vill använda för utvärderingen. Ska sättas till 'P31' (instans av (P31)) vid anrop (däremot anropar funktionen sig själv med underklass till (P279))
• Vad funktionen gör: funktionen loopar igenom alla värden för objektets instans av (P31).
  • Om dess värde är landslag (Q1194951) returnerar den sant.
  • Om den har något annat värde anropar den funktionen sig själv för att undersöka om värdet är en underklass till (P279) till landslag (Q1194951)

txtPosition

• Syfte: Skapa tabellcell med en person/ett lags placering i en tävling, som är färgsatt om de kom på medaljplats
• Returnerar: textsträng (html-kod för cellen)
• Argument:
  • iPosition – placeringen i tävlingen
• Vad funktionen gör:
  • Skapar en tabellcell med placering
  • Placeringen är 1 (█), 2 (█) eller 3 (█) får cellen respektive färg, annars ingen bakgrund.

txtTeamname

• Syfte: Avgöra namnet på ett lag under ett visst år
• Returnerar: textsträng (lagnamnet som wikilänk)
• Argument:
  • idTeam – id (Q följt av ett nummer, som t.ex. 'Q3873841' för Sveriges damlandslag i volleyboll (Q3873841)) för lagets objekt
  • year – årtalet för vilket du vill veta klubbens namn
• Vad funktionen gör: undersöker klubbens officiellt namn (P1448). Om det är satt loopar den igenom alla värden
  • Om värdet har bestämningarna att
    • startdatum (P580) <= year och det inte finns slutdatum (P582)
    • startdatum (P580) <= year och slutdatum (P582) >= year
    • Det inte fanns startdatum (P580) och slutdatum (P582) >= year,
  • så returnerar funktionen det värdet (namnet) för den bestämningen
    • ett undantag är om namnet är tomt (nil) då returnerar funktionen istället 'Namn ej inlagt på svenska än'
  • Om funktionen inte hittar något värde där bestämningarna uppfyller villkoren ovan returnerar funktionen 'Namn finns inte för det årtalet'

txtYears

• Syfte: Formatera en textsträng med start- och/eller slutår
• Returnerar: textsträng
• Argument:
  • startyear – startår (kan vara tom)
  • endyear – slutår (kan vara tom)
• Vad funktionen gör (returnerar):
  • Om både startyear och endyear finns:
    • Om de är olika: returnerar startyear–endyear
    • Om de är samma: returnerar startyear
  • Om startyear finns, men inte endyear: returnerar startyear–
  • Om endyear finns, men inte startyear: returnerar –endyear
  • Om var sig startyear eller endyear finns: returnerar tom sträng