Retningslinjer for Skribenter

Fra Holstebro HTX Wiki
Skift til: navigering, søgning

Dette er en side der beskrive de overordnede retningslinjer for at skrive i denne komm-IT wiki.

Ideen er, at vi får et nogenlunde harmonisk indhold i wikien.

Sproglige regler

For at wikien skal blive harmonisk at læse, så er det godt at have samme skriveregler gennem hele wikien.

Skriv i 3. person

Skriv altid man - ikke jeg, vi, os osv. Vær objektiv og saglig.

Vær præcis

Undgå lange sætninger. Skriv kort og præcist (kvalitet frem for kvantitet). Vær opmærksom på at du ikke gentager dig selv.

Skriv varieret

Undgå at bruge den samme betegnelse for et givet subjekt. Hvis man fx skriver om Gallups Kompas, er det en god idé at nævne det som “kompasset” hvis man har brug for at henvise til det - således for man et mere varieret sprog.

Skriv godt dansk

Ret naturligvis stavefejl og tegnsætning.

Udnyt wikiens muligheder

wikien er et webbaseret medie, og har mange tekniske muligheder for at understøtte god kommunikation.

Afsnitsopdel

Anvend overskrifter til at strukturere indholdet, så det bliver overskueligt.

Når man har 4 overskrifter på, så får man automatisk en indholdsfortegnelse på siden.

Man kan også styre både hvor og om man vil have indholdsfortegnelsen på[1]

Sideopdel

Hvis sider bliver for store, så del det op i flere undersider, hvor der er naturlige elementer at beskrive.

Henvis

Hvis noget er uddybende beskrevet et sted i wikien, så henvis i stedet til siden med et internt link:

[[link]]

Anvend referencer

Når man trækker information ind fra en kilde, eller endda citerer en kilde, så anvend referencer til at henvise[2] med, så der opbygges automatiske kildelister på siderne. Man indsætter en reference ved at skrive f.x. som følger:

<ref>http://www.mediawiki.org/wiki/Help:Extension:Cite Mediawikis beskrivelse af Cite - Set 9/12-2012</ref>

Husk også at anvende name-egenskaben for at henvise flere gange til samme kilde fra en side. Det kan man gøre ved at skrive følgende første gang man anvender henvisningen:

<ref name="Cite">http://www.mediawiki......</ref>

Næste gang man vil henvise kan det gøre ved blot at skrive:

<ref name="Cite" />

Automatisk kildeliste ud fra referencer

Hvis man ikke selv husker at gøre det, så bliver der gjort opmærksom på, at man mangler et References-tag. I denne wiki placeres det nederst på siden i et afsnit der hedder referencer:

==Referencer==
<references />

Anvend billeder

For at understøtte kommunikationen i wikien, så er det en god ide at anvende illustrationer.

Det er bedst at anvende billeder der indgår i den grafiske linje, så det kan være nødvendigt at fremstille illustrationerne selv.

Der hvor man finde illustrationer der passer i den grafiske linje, skal man selvfølgelig sikre sig at man ikke bryder nogens copyright, det kan f.x. være ved at anvende illustrationer der er udgivet under creative common. Under alle omstændigheder er det en god ide at henvise til billedets oprindelige placering med en reference.

Grafisk linje

Det kan være en god ide at der er en grafisk ensartethed i hvordan billeder er opbygget.

Layout

Måden at siderne er sat op på skal også følge den samme linje.

Overskrifter

Ved at afsnitsopdele siderne, og anvende overskrifter i niveauer der passer til indholdet, så giver det et fornuftigt layout på siderne.

Kategori Struktur

Hele kategori-strukturen et lavet for at kunne danne den totale indholdsfortegnelse for wikien der vises på Indhold siden. Denne indholdsfortegnelse dannes automatisk ud fra kategorierne, og det kræver en lidt speciel oprettelse af de sider der selv er en kategori.

Oprettelse af en kategori-side

En ny kategori oprettes vil at oprette en side, hvor siden placeres i den ønskede kategori. Det gør man ved at lave en henvisning der hedder:

[[kategori:Navnet på kategorien]]

Denne henvisning kan stå helt vilkårligt på den side der skal være i kategorien, men layout-mæssigt placeres den nederst på siden, så det kan være en god ide at placere den der i teksten. Kategori-henvisningen henviser til kategori-siden.

Indholdet på denne kategori-side er ret begrænset, da den skal have to funktioner:

  • Henvise til siden med indholdet i kategorien
  • Placere sig selv i kategorierne

Henvisningen til siden med indhold i kategorien laves ved hjælp af følgende kode:

#Redirect [[Navnet på kategorien]]

Dette gør, at man bliver henvist til en side med samme navn som kategorien, hvor indholdet der dokumenterer det kategorien indeholder.

Hvis kategorien er en overordnet kategori (hovedpunkt i indholdsfortegnelsen), så skal den blot have en kategori der hedder:

[[kategori:kategori]]

Dette skal gøres for at den ikke kommer til at optræde som ikke kategoriseret.

Hvis det er en underkategori under en eller flere overordnede kategorier, så skal den have disse kategorier ind i denne kategori-side ved at skrive som følger:

[[kategori:Navnet på den overordnede kategori]]

Oprettelse af indholdet i siden med navnet på kategorien

Hvis siden ikke er oprettet, så kan man gøre det ud fra det link der er i omdirigeringen inde i kategori-siden. Ellers er der kun et enkelt krav til siden:

Man må ikke sætte kategorier på siden (det skal gøres inde i selve kategori-siden), men den skal til gengæld have en bestemt kategori der hedder:

[[kategori:kategori]] 

Dette skal gøres for at den ikke kommer til at optræde som ikke kategoriseret.

Referencer