Redigerer Modul:Kinfo/dok

'''Modulen «{{BASEPAGENAME}}» inneholder:'''
*en funksjon (main) som gjør det mulig for skriptet å hente data fra [[Modul:Kinfo/data]] ved å angi [[kommunenummer]] eller fylkesnummer.
== Parametere ==
For alle funksjoner kan det angis tre ubenevnte parametere:
<code><nowiki>{{#invoke:Kinfo|funksjon|1|2|3}}</nowiki></code>.
*<code>main</code> returnerer i utgangspunktet en verdi etter ønske.
**Første verdi etter <code>main</code> <code>(1)</code> må være kommunenummeret, det sendes feilmelding om den ikke finnes i listen. (kreves)
***Under <code>main</code> kan man kalle på <code>hent=</code> som default er satt til <code>kommune</code>.
****Andre verdier som kan brukes med <code>hent=</code> er: (per 24. januar 2020 tillates kun en verdi i hent)
*****<code>kommune</code> som henter navnet på kommunen med stor forbokstav.
*****<code>totAreal</code> som henter totalt areal inkl. territorial-farvann.
*****<code>areal</code> som henter areal for fastland og øyer.
*****<code>havflate</code> som henter havflate (terretorial-farvann).
*****<code>apentOmrade</code> som henter areal for åpent område.
*****<code>snoIsBre</code> som henter areal for snø, is og bre.
*****<code>innsjo</code> som henter areal for innsjø.
*****<code>elvTorrfall</code> som henter areal for elv med tørrfall.
*****<code>myr</code> som henter areal for myr.
*****<code>skog</code> som henter areal for skog.
*****<code>dMark</code> som henter areal for dyrket mark.
*****<code>btBygg</code> som henter areal for by- og tettbebyggelse.
*****<code>industri</code> som henter areal for industriområde.
*****<code>annet</code> som henter areal for sports- og idrettsplass, alpinbakker, steinbrudd, steintipp, park, flyplass, rullebane, golfbane og gravplass.
*****<code>landareal</code> som henter areal for landareal (SSB).
*****<code>ferskvatn</code> som henter areal for ferskvatn (ferskvann inkluderer elver fra 2010 - SSB).
**Verdier etter <code>(1)</code> kan være:
***<code>enhet</code> legger på verdien «<small>km²</small>» til slutt (så lenge det ikke er kommune som hentes). (valgfri)
***<code>ref</code> legger på en referanse til slutt for hvor dataen er hentet fra. (valgfri)
*<code>innbprkm</code> returnerer en utregnet verdi etter parametere som er gitt.
**Ved bruk av <code>innbprkm</code> må man kalle på <code>knr=</code> (kommunenummer) og <code>innb=</code> (innbyggere). Kun tallverdier er godkjent, uten formateringer. (kreves)
***Verdier etter <code>knr=</code> og <code>innb=</code> kan være:
****<code>enhet</code> legger på verdien «<small>innb./km²</small>» til slutt (så lenge det ikke er kommune som hentes). (valgfri)
****<code>ref</code> legger på en referanse til slutt for hvor dataen er hentet fra. (valgfri)
*<code>tabell</code> returnerer en tabell for et fylke, med informasjon om alle kommune i fylke med alt av data som finnes om kommunene.
**Verdi <code>(1)</code> må være et [[fylkesnummer]] (under arbeid - kreves).

;Bruk i infoboks
* <code><nowiki>{{#invoke:Kinfo|main|wd|hent=XXXX|ref|enhet}}</nowiki></code> - Henter kommunenummer eller fylkesnummer fra Wikidata-element/nærmeste kommune element på WD.
* <code><nowiki>{{#invoke:Kinfo|innbprkm|wd}}</nowiki></code> - Henter innbyggertall og kommunenummer eller fylkesnummer fra Wikidata-element/nærmeste kommune element på WD.
* <code><nowiki>{{#invoke:Kinfo|main|kBefolkning}}</nowiki></code> - Henter beste befolkningstall fra Wikidata-element/nærmeste kommune element på WD.
* <code><nowiki>{{#invoke:Kinfo|main|knr}}</nowiki></code> - Henter beste kommunenummer fra  Wikidata-element/nærmeste kommune element på WD.

== Eksempel ==

{| class="wikitable"
! Forklaring !! Kode !! Resultat
|-
| Kommunenummer 301 for [[Oslo]], henter navn. || <code><nowiki>{{#invoke:Kinfo|main|301}}</nowiki></code> || {{#invoke:Kinfo|main|301}}
|-
| Kommunenummer 301 for [[Oslo]], henter navn med ref. || <code><nowiki>{{#invoke:Kinfo|main|301|ref}}</nowiki></code> || {{#invoke:Kinfo|main|301|ref}}
|-
| Kommunenummer 301 for [[Oslo]], henter landareal med enhet. || <code><nowiki>{{#invoke:Kinfo|main|301|hent=landareal|enhet}}</nowiki></code> || {{#invoke:Kinfo|main|301|hent=landareal|enhet}}
|-
| Kommunenummer 301 for [[Oslo]], henter totalt areal inkl. territorial-farvann med enhet og ref. || <code><nowiki>{{#invoke:Kinfo|main|301|hent=totAreal|enhet|ref}}</nowiki></code> || {{#invoke:Kinfo|main|301|hent=totAreal|enhet|ref}}
|-
| Kommunenummer 301 for [[Oslo]], henter myr med ref. || <code><nowiki>{{#invoke:Kinfo|main|301|hent=myr|ref}}</nowiki></code> || {{#invoke:Kinfo|main|301|hent=myr|ref}}
|-
| Fylkesnummer 34 for [[Innlandet]] fylke, henter myr med ref. || <code><nowiki>{{#invoke:Kinfo|main|34|hent=myr|ref}}</nowiki></code> || {{#invoke:Kinfo|main|34|hent=myr|ref}}
|-
| Fylkesnummer 34 for [[Innlandet]] fylke, henter landareal med enhet og ref. || <code><nowiki>{{#invoke:Kinfo|main|34|hent=landareal|enhet|ref}}</nowiki></code> || {{#invoke:Kinfo|main|34|hent=landareal|enhet|ref}}
|-
| Kommunenummer 301 for [[Oslo]] kommune, henter og regner ut innbygger tetthet. || <code><nowiki>{{#invoke:Kinfo|innbprkm|knr=301|innb=673469|ref}}</nowiki></code> || {{#invoke:Kinfo|innbprkm|knr=301|innb=673469|ref}}
|-
| Kommunenummer 301 for [[Oslo]] kommune, henter og regner ut innbygger tetthet med enhet || <code><nowiki>{{{#invoke:Kinfo|innbprkm|knr=301|innb=673469|enhet}}</nowiki></code> || {{#invoke:Kinfo|innbprkm|knr=301|innb=673469|enhet}}
|-
| Fylkesnummer 3 for [[Oslo]], henter alle kommuner og legger alle verdier inn i en tabell. || <code><nowiki>{{#invoke:Kinfo|tabell|3}}</nowiki></code> || {{#invoke:Kinfo|tabell|3}}
|}
===Referanser===
<references />