Modul:Sandkasse/Sechinsic/Kilde/dok

Dette er dokumentationsundersiden til Modul:Sandkasse/Sechinsic/Kilde.
Denne side indeholder information om brug, kategorier samt andet indhold, som ikke er en del af den oprindelige modulside.

Find testcase på Skabelon:KildeTST dokument

Modul:Kilde har det samme motiv som {{Citation/core}}; at samle html-formateringen af flere forskellige slags kildeangivelser.

Det er stærkt anbefalelsesværdigt at benytte muligheden for at indsætte links til fuldtekst, men alligevel er det vigtigt at holde fast i kildeangivelserne er en hjælp til at finde en given tekst. Men kildeangivelsen er ikke kun det, men også i sig selv en informationskilde.

Status

Modul:Kilde er ikke skrevet endnu(!) men p.t. findes "Modul:Sandkasse/Sechinsic/Kilde" som i det følgende refereres til som Modul:Kilde. Modulet er ikke endnu til brug i Wikipedia-artikler, men gerne alle andre steder. Modulet vil blive ændret og måske også slettet.

juni 2015, foreløbig version.

Test skabelon Skabelon:KildeTST dokument som også viser test af andre #Dokumenttyper.

Udkast til dokumentation; denne side ~ Modul:Kilde/dok.

Funktionelt layout for bøger og tidsskrifter, nyhedsartikler og normative dokumenter samt internet-tekster.

Beskrivelse af Lua script mangler, men scriptet har kommentarer.

Modul:Kilde benytter "mw.loadData" til at indlæse Modul:Kilde/R1.

Af kommentarerne fremgår hvordan man kan efterprøve scriptet uden at behøve en MediaWiki installation.

uri.encode eller ikke

It is impossible to encode a URL without knowing about its specific parts.

http://blog.lunatech.com/2009/02/03/what-every-web-developer-must-know-about-url-encoding

(mere om det samme, [1])

Præmissen er at den url der bruges i |url=, |url2= og |tilgang= allerede er url-encoded. Sikkerhedsmæssigt er (øhh) modulet her kun en dråbe i det store Wikipedia-hav. Der er ikke noget specifikt for netop modulet her der gør modulet mere fortrinligt for en hacker - i hvert fald hvad angår url-skemaet. Det er jo også heldigt nok, for dette moduls script design/layout/stil er virkelig kun målrettet formateringen af kildeangivelser!

Sammenligning med 'Citation/core':

Mangler en dokumenttype for patent referencer

Tilføjet autrunc authmask + signatur for oversætter & et meget mere brugbart layout

Der er ikke noget fristils-element, dvs. |Other= fra {{Citation/core}}

Testbrug

Eksempel på en skabelon der kalder modulet,

<noinclude>
{{Dokumentation}}
[[Kategori:Skabelonsandkasser]]
</noinclude><includeonly>{{#invoke:Sandkasse/Sechinsic/Kilde|m
|DT = {{{DT|Dokument}}}
|url2 = {{{tilgang|}}}
}}</includeonly>

|DT= - må være en af de genkendte dokumenttyper

|url2= - skabelonen opretter et alias for 'url2'

Generelt

Dokumentation for den script-tekniske proces er ikke beskrevet her.

Modulet fungerer kun igennem to led, med den konsekvens at et af disse led må være en skabelon. I alt bliver 4 'sider' brugt: Parametre fra eksempelvis en side i artikel-navnerummet, skabelonen der dokumenterer parametrene, Modul:Kilde og Modul:Kilde/R1.

Modul:Kilde fungerer mere konsistent end Citation core-skabelonen. Det skyldes parameteret |DT= og på trods den større mængde af parametre. <DT> bruges i modulet til at afgøre hvilke parametre der er relevante. Eksempelvis genererer det ikke nogen fejl at bruge |DT=Bog, |portal=Gyldendals - portal parametret bliver bare ikke formateret - det kan også siges modulet er mere firkantet.

Formateringen benytter ligesom 'Citation/core' <span>...</span> for at holde styr på de numeriske indices. Yderligere er span-elementet i brug for at tilføje inline css og der bliver derfor genereret en smule ekstra markup.

Generelt kontrollerer modulet ikke parametrerne; retningslinjen her er at kildeangivelsen ikke principielt adskiller sig fra artikelteksten - parametrerne sammenskrives og formateres, men redigeres ikke. Men der er nogle undtagelser.

Obligatoriske parametre. Formateringen kan afbrydes når visse parametre mangler. Se nedenfor, #Dokumenttyper.
Layout parametre. Modulets standard rutine kan ændres - se nedenfor under #Layout parametre og deres standard værdi eller under Parametre.
Links. ((A) Tjekkes for protokol præfiks. Det er nødvendigt at angive en protokol - ikke implementeret, så url uden protokol virker ikke) (B) Ved internet-tekster og ved normative tekster ændres |site= hhv. |tilgang= til en læsbar, dvs. forkortet form. Specielt |tilgang= giver en fuld url og den forkortede form bliver til en del af link-teksten. |site= bliver ikke præsenteret som et link.
Html-anker for <cite>...</cite>. Selvom tidsangivelsen indgår i ankeret er det kun den del af tidsangivelsen der matcher et 4-cifret årstal der bruges.
Appendiks-parametre (se også #Layout). Parametrene formateres til links på nogenlunde samme måde som det er kendt fra 'Citation/core'.

Modulets begrænsning

Kort fortalt, tekst. Specielt indlemmelsen af dokument typen for nyheder, med nøgleordet Avis, medfører ikke nogen betingelse for om det nu drejer sig om et trykt medie eller et online nyhedsmagasin - hvilket selvfølgelig også gælder for tidsskrifter. Henvisningen til online tekster er en udfordring, men netop nyhedsgenren er nogenlunde håndterlig. Den almindelige tilgængelighed til online ressourcer omfatter både billede og lyd og der er forsåvidt ikke nogen aktuel argumentation for at foretrække tekst - udover at det i nogle tilfælde er lettere at kategorisere en tekst, og specielt trykte medier. Der er en filosofisk dybde i dette at en kildetekst er svær at kategorisere, som summarisk må siges at være et vilkår. Netop nyhedsgenren har fået et par kontroversielle tilføjelser, omtalt under #Dokumenttyper.

Layout

Html formateringen af kildeangivelsen har som udgangspunkt fokus på fleksibilitet, konsistens og læsbarhed.

Layout for bøger og tidsskrifter følger vistnok i store træk DS/ISO 690:2010 Version 1 - Name and date.^[1]

Formatet stemmer også stort set overens med CS1 fra den engelske Wikipedia version - se specielt en:Wikipedia:Citation Templates.

DS/ISO 960: (1)Forfatter (2)År (3)Værk (3a)Redaktør (3b)Samleværk [(4) medium] (5)Udgave (6a)By (6b)Forlag (7)Serie / Volume / Nummer og lignende (8) supplerende

^[1]

Der er - med nævnte forbehold - nogle afvigelser. Specielt bruges ikke medium - også ifølge #Modulets begrænsning - og by/forlag efterstilles de sædvanlige indices pånær sideangivelse.

En vigtig retningslinje ved formateringen af kildeangivelser er konsekvens, d.v.s ensartethed. Det er først og fremmest som følge af modulets automatik let at opnå. Men der er ikke nogen garanti for at Wikipedias redaktører kun bruger Modul:Kilde. Desuden kan det konsekvente layout også opfattes mere nøjeregnende og dermed omfatte et konsekvent indtryk på tværs af de forskellige dokumenttyper modulet skelner mellem og selvfølgelig også på tværs af variansen i en enkelt dokumenttype. Jo flere felter, jo vanskeligere, især da kildeangivelsen ikke bør ligne et rent indeks.
I moderne akademia er elektronisk indeksering blevet almindelig, og disse indices er ikke særligt læsbare - da de jo består af en lang række cifre. Vigtigheden af at inkludere disse står ikke til diskussion og som et kompromis mellem læsbarhed og inklusion er de elektroniske indices, inklusiv ISBN, Webarkiv og resume(laysummary) samlet i et appendiks til kildeangivelsen.
Normbrydende er understregning del af layoutet. Det drejer sig om de konstante fyldord I:, Bind:, red., udgave, Ovs:, Ovs&redigering:. Understregning af ord og fraser er i konflikt med markeringen af links, men i sammenhængen her burde det være klart nok det ikke er en link-markering. Specielt er sammenstillingen mellem de dansk-sprogede "I", "Bind", "udgave" med ex. engelske og tyske - generelt fremmedsprogede - kildetekster egentlig særpræget, og understregningen markerer så den automatik der ligger til grund for sprogblandingen.
Som konsekvens af de nye dokumenttyper, dels nyhedsartikler og specielt internet-tekster er kilde-formatet tilføjet et kreativt element, nemlig brug af em-tegnet, "—". Se Skabelon:KildeTST dokument for eksempler. På engelsk Wikipedia - og i gængse trykte litteraturlister - forekommer em-tegnet som placeholder for forfatternavn når denne står for flere kildetekster.
I valget mellem at foranstille tid under alle omstændigheder eller betinget der er en skribent eller redaktør er det for læsbarhedens skyld blevet til det sidste - en dato efter kildetekstens titel forekommer ikke. Specielt for normative dokumenter sker det at der ikke findes oplyst hverken navngivne skribenter eller redaktionelle udvalg, men for denne dokumenttype vil tiden altid være foranstillet. Se eksempler på {{KildeTST dokument}}.
Formatet "kildetekst". tidsskrift blev først kalkeret over til "Avis"-typen, med den konsekvens at 'redaktion' blev efterstillet. Denne struktur blev så kalkeret over "Web"- og "Meddelelse"-typen. Men her er det alligevel mere passende at bryde med traditionerne. For "Meddelelse" betyder det at ex. forum-tråd og navn på blogs der kommer fra en portal kommer før forum-navn hhv. navn på blogportal - portal informationen er noget similar oplysningen om bogserier. "Web" typen er mere ubestemt, men når typeangivelsen følger referencen til en tidsskriftsportal vil det betyde at tidskriftets navn, portal parameteret, ikke står i kursiv. Se også #Web.

Inline CSS

Kerning af mellemrum og gåseøjne.

Kerning af gåseøjne bruges når kildetekstens titel begynder eller afsluttes med citationstegn eller gåseøjne ('").

Diverse font-, margin- og pad-værdier for appendiks-delen.

Layout parametre og deres standard værdi

Parametrene er supplerende og det er ikke nødvendigt at bruge dem.

Fra Modul:Kilde/R1.

		["TrunkSkrb"] = "9",
		["TrunkRed"] = "3",
		["Sep"] = T.L.sep,
		["SepN"] = T.sepn,

Parametre der er enten tomme eller ikke-tomme, dvs. booleans. Deres standardværdi er tom.

		"Amp",
		"Anon",
		"Em",             --|AuthMask fra enwiki
		"Form",
		"KonfNavn",
		"PS",
		"RefHTML",

Diverse

Et par snurrigheder der er værd at nævne:

Tegnsætningen der markerer kildeangivelsens felter (|Sep=T.L.sep) starter som standard med et punktum. Specielt for navneforkortelser kan det medføre dobbelte punktummer i kildeangivelsen. Kun når forkortelsen findes i et af navne-parametrene - se #Parametre - sørger modulet for en korrekt tegnsætning.
Genereringen af html-ankeret der bruges til fodnote links afsluttes kun med et 4-cifret årstal når |tid= også indeholder, eller består i et sådant. Ellers følger modulet den samme rutine som Citation core. Se også under #Parametre

Dokumenttyper

Dokumenttyperne svarer næsten i princippet til |Citation class= fra Citation core-skabelonen. I modulet hører de også med til proces-forløbet - det gjorde de ikke i Citation core. Ideelt afspejler de en bestemt type af kildetekster.

Oversigten over de forskellige dokumenttyper beskriver en typologi;

Kildetekst: Forfatter og titel
Primær relation: Redaktionel sammenhæng
Sekundær relation: Publicist sammenhæng
Indeks: Diverse numre, tider, serier
Label: Markering af tekstens dokumenttype
Appendiks: Nyere indeks, typisk numerisk og målrettet 'maskinel' aflæsning

Bog

Obligatorisk: [titel]
Kildetekst:

[titel skribent] -- forfatter og tekst.

[skribenttid] -- sjældent forekommende.

Primær relation:

[bog red]

Indeks:

[serie volume side] -- traditionelle indices.

Sekundær relation:

[forlag sted]

Tidsskrift

Typisk tema er akademisk orienteret.

Obligatorisk: [titel tidsskrift]
Kildetekst:

[titel skribent] -- forfatter og tekst.

Primær relation:

[tidsskrift red] -- Nogle tidsskrifter bruger også tematiske inddelinger, eksempelvis en særskilt sektion om anmeldelser. En redaktionel inddeling kan p.t. kun repræsenteres for <DT> "Avis", se nedenfor.

Indeks:

[serie volume nummer side] -- det er de traditionelle indices. I modsætning til hos bøger er tidsskriftets serie et tal.

Sekundær relation:

[forlag sted]

Dokument

Typisk tema er regelsæt, alias normsæt.

Obligatorisk: [titel institution]
Kildetekst:

[titel skribent red_udvalg] -- forfatter og tekst. Forfatteren er ofte upersonlig.

Primær relation:

[institution]

Indeks:

[formalnavn]

[kategori nummer] -- lovregulativer, tekniske rapporter, eventuelt også standard specifikationer og manualer. Kategorien bør gengive en ordret forekomst fra kildeteksten.

Avis

Typisk tema er nyheder.

Obligatorisk: [titel avis]
Kildetekst:

[overskrift skribent] -- forfatter og tekst.

Primær relation:

[avis]

[redaktion red] -- redaktør sammenstilles her med navngivningen af den relevante redaktion.

[institution] -- når skribenten er personificeret og formidler en organisations synspunkt. Skribentens tilhørsforhold til organisationen må tydeligt fremgå af kildeteksten.

[nyhedskilde] -- almindelig journalistisk praksis er at gengive et 'newsflash' alias en pressemeddelelse. Nyhedskilden må tydeligt fremgå af kildeteksten.

Indeks:

[side]

Sekundær relation:

[forlag by] -- sjældent forekommende i kildeangivelser.

Web

Mange hjemmesider falder ikke ind under servicetyperne nævnt under #Meddelelser. Det er muligt at producere en hjemmeside på mange forskellige måder. Specielt CMS er almindeligvis et internt redigeringsværktøj, ikke en servicetype. Den retningsgivende institution for internettet er IETF så egentlig er der kun en forlægger for alle hjemmesider. Hvem udgiver en hjemmeside? - er et spørgsmål der bliver ved at trænge sig på, også efter dette afsnit. Reglen må være at det er op til hjemmesiden at tydeliggøre hvem der har det redaktionelle initiativ.

Obligatorisk: [url titel]
Kildetekst:

[titel skribent] -- forfatter og tekst.

Primær relation:

[tema] -- når det tydeligt fremgår af websitets navigations-system at kildeteksten er del af et tema.

Indeks:

[url] -- url til tekst

Sekundær relation:

[site portal] -- domænenavn, almindeligt navn på webportal.

[institution sted] -- når det er relevant i sammenhængen, eksempelvis som navn på en institution eller organisation.

Label:

- Som udgangspunkt "Web", eventuelt suppleret med "site" eller "portal"

Meddelelse

Dokumenttypen 'Meddelelse' betyder her en internet tekst. Som følge af internet teknologien er de sædvanlige indices ikke nødvendige. Meddelelser kan ikke være anonyme. Det typiske tema er nyheds-agtigt.

Det er kun maillister og newsgroups der er teknisk konsistent strukturerede - se eventuelt RFC-1036, Horton & Adams (1987). Kildetekstens substantielle indhold har principielt set ikke noget med standards-konformitet at gøre og forsøgsvis er mailliste og newsgroup her i selskab med blogs og forum-poster.

Obligatorisk: [url titel skribent]
Kildetekst:

[titel skribent] -- forfatter og tekst.

Primær relation:

[service] -- navn på mailliste, newsgroup, blog. For newsgroups bliver navnet formateret til et link med protokol-præfiks "news:" og skrevet ind i appendiks. For forums vil det være mest relevant at her skrive den nærmeste forum-afdeling.

Indeks:

[url] -- link til tekst.

Sekundær relation:

[site portal] -- domænenavn, almindeligt navn på webportal.

Appendiks (alternativ url):

[nummer] -- et identifikationsnummer visse services tilbyder.

Label:

[kategori] -- en af typerne mailliste, forum, newsgroup, blog.

Parametre

Dette afsnit er ikke helt opdateret.

Parameternavne findes som konstanter i Modul:Kilde/R1. Navne i kursiv angiver en intern variabel og parametre er markeret |<parameternavn>= eller i citationstegn (').

Det specielle parameter <DT> angiver kildetekstens dokumenttype som må være en af "Bog", "Tidsskrift", "Avis", "Web", "Dokument". Bemærk, <DT> aflæses kun fra første led i parameterkæden som må være en skabelon. (eventuelt et modul?)

Almindelige parametre

Kildetekstens forfattere

|skribentN= - hvor N er et tal mellem 1 og 9, begge inklusive.
|fornavnN=
|efternavnN=

Redaktører

|red= - hvor N er et tal mellem 1 og 3, begge inklusive.
|red_fornavnN=
|red_efternavnN=
|redlinkN= Som ovenfor
|red_udvalg= Til brug for <DT> "Dokument". Angiver arbejdsgruppe, udvalg og lignende, men ikke institution som har et særskilt parameter.

kilde - kildetekstens titel: Obligatorisk for alle kildetekster

|overskrift=
|titel=

vaerk - titel på en tekst-sammenhæng.: (Obligatorisk for konference bidrag - forsøgsvis implementeret)

|bog=
|konference=

blad - titel på en tekst-sammenhæng. Beskriver en redaktionel sammenhæng.: Obligatorisk for <DT> "Tidsskrift", "Avis"

|avis=
|tidsskrift=
|portal=

no4 - titel på en tekst-sammenhæng. Eventuelt underordnet blad.

|redaktion=
|formalnavn=
|tema=

diverse

|tid= Den foranstillede tid. Som en tommelfingerregel er det tid for publikation. Specielt for html-ankeret der benyttes til fodnote link bruges kun den del af tiden der matcher 4 sammenskrevne cifre. Når 'tid' ikke indeholder et sådant - hvad det burde gøre - bruges 'tid' heller ikke til denne mekanisme.

Obligatorisk for <DT> "Avis"

|ep= Editio princeps. Første trykkeår, uanset forlag eller sprog.
|skribenttid= Beskriver hvornår teksten blev skrevet. Relevant for klassiske forfattere.
|otid= Tid for bogens førsteudgave - det følger som regel et bestemt forlag.
|bladtid= En sæsontid eller månedsnavn. Foranstilles "nummer".
|udgave= Kun et heltal. Værdien sammenskrives med ". udgave".
|kommenteret_udgave= En friform til at beskrive udgaven. Formateres i parentes.
(|medskribent= tom/ikke-tom (1.forfatter & et.al.))?
|ov= Navn på oversætter.
|ov_red= Navn på oversætter og redaktør.
|serie= Titel på en bogserie.
|volume= , dvs. bind. I brug for både tidsskrift og bøger.
|nummer= I brug ved alle dokumenttyper pånær "Avis" og med forskellig betydning.
|side= Sidetal.
|forlag= Forlag/udgiver.
|institution= I brug ved de nyere dokumenttyper og med forskellig betydning. For internet-tekster påpeger "institution" en publicist rolle; ellers beskriver parameteret en redaktionel relation til kildeteksten.

Obligatorisk for <DT> "Dokument"

(|genoptryk=)?
(|illus=)?
|kategori= Til brug for <DT> "Dokument", eventuelt suppleret med |nummer=.
|nyhedskilde= Til brug for <DT> "Avis". Parameteret giver mulighed for at markere artiklen bygger på en pressemeddelelse fra et nyhedsbureau.
|servicetype= -- ikke implementeret

Obligatorisk for <DT> "Meddelelse" -- ikke implementeret

(|sprog=)?
(|titelov=)? En fri oversættelse af en fremmedsproget titel/Kildetekstens fremmedsproglige originaltitel når kildeteksten er oversat.
|url= Link til kildetekst. Fortrinsvis må linket pege på en frit tilgængelig fuldtekst-version.

Obligatorisk for <DT> "Meddelelse", "Web" (samt upubliceret konference-bidrag)

|url2= I brug ved bøger og dokumenter til at angive hhv. link til |vaerk= og link til yderligere oplysninger.
|urldato= Fuld tid, dvs. dato for hvornår |url= blev hentet.
|site= Beskriver en hjemmeside. Uformel alternativ til |portal=.

sted

|sted= Publikationens geografiske sted. Fortrinsvis et bynavn.
(|kfcsted= Relevant for konference-bidrag. Foranstilles sammen med tid.)

Layout parametre

Parametre med standard-værdier.

|TrunkSkrb=9 Heltal. 'Trunk'-parametrene gør det muligt at forkorte de angivne skribent hhv. redaktør-lister og resulterer også i tilføjelsen af "et.al.". Som standard trunkeres hverken skribent-lister eller redaktør-lister, og de to 'Trunk'-parametre er sat til det maksimale antal skribenter hhv. redaktører der kan listes. (Måske er disse parametre mest relevant når der også er en forventning om at de resterende navne faktisk bruges til et eller andet, eksempelvis som microdata?)
|TrunkRed=3
|Sep=T.L.sep Tegnsætning. Markerer kildeangivelsens felter - som burde være beskrevet i skabelonens dokumentation. T.L.Sep er ". " augmenteret med "nbsp" til at give et lidt større mellemrum end den bogstavelige/literale 'string'.
|SepN=T.sepn Tegnsætning. Markerer adskillelse af navne. T.sepn er "; ".

Tomme parametre (A).

|Em= Heltal. Når flere værker af samme skribent(er) findes i litteraturlisten kan dette parameter bruges til at indsætte en eller flere em-tegn (—) istedetfor skribentens navn. Når 'Em' er sat bliver 'skribent1' hhv. 'fornavn1' & 'efternavn1' ikke anvendt. (Denne implementering/algoritme er ikke helt konsistent)
(|Form= A, A1, A2, B. Midlertidig, kun for <DT> "Dokument".)
( |PS= Tegnsætning. )- ikke implementeret
|RefHTML= Kan forkorte kildeangivelsens html-'anker', der benyttes i sammenhæng med fodnoter. 'RefHTML' forventes at samstemme med en standardværdi fra {{Harv}} - standardværdien findes i Modul:Kilde/R1 som M.citeref og sættes altid til denne værdi. Hvis parameteret er tom genereres en konkatenering af skribenter eller redaktører (ideelt set efternavne) og tid. Ellers sammenskrives standardværdien med parameterværdien. Når kildeangivelsen angiver en eller to skribenter ved efternavn og en publikationstid fungerer den automatiske generering fortrinligt, og vedligeholdelsen af litteraturliste og fodnoter bliver triviel.

Tomme parametre (B).: En hvilkensomhelst værdi aktiverer parametrene - ex. |KonfNavn=ja, |KonfNavn=nej, |KonfNavn=måske eller |KonfNavn=ved ikke medfører det samme resultat.

|Amp= Bevirker at "&" sættes mellem de to sidste skribenter hhv. redaktører. Parameteret gælder for både forfattere og redaktører.
|Anon= Medfører foranstillet tid: "Anon (<tid>)". Det er - ideelt set, eller forhåbentlig - sjældent relevant og kun for <DT> "Web" og "Avis". Specielt for <DT> "Dokumenter" er der taget højde for tekster uden forfattere. Bemærk, parametret nulstiller listen over forfattere.
|KonfNavn= Adskillelse af for- og efternavn gør det lettere at bruge {{Harv}} i fodnoterne. Parameteret kan bruges for at undgå adskillelsen i det færdige layout, dog undtaget første skribentnavn der - ifølge ISO - altid må være på formen "efternavn, fornavn".

Referencer

Noter

^ ^a ^b (Wille & CBIT)

[autogeneret1-1] (Wille & CBIT)

[1]