Wiki utformingsregler

Fra Mandriva Norway

Gå til: navigasjon, søk


Mandriva Linux Wiki stilrettningslinjer

Det er et definitivt behov for å opptre enhetlig når så mange mennesker redigerer hverandres dokumenter, og disse retningslinjene viser de nødvendige instrumentene som må til for å redigere i denne wikien. De vil også vise til de forskjellige malene og stilene du kan og bør bruke, og når du bør bruke dem. Her gjøres det oppmerksom på hierarkiet og utformingen av wikien, generelle redigerings-godsaker, og annen viktig informasjon.

Dersom du ønsker å bli betraktet som en verdifull resurs rundt det å vedlikeholde og redigere dokumenter, og ikke en plage, så er denne siden obligatorisk lesning!

Alle har sin personlige stil. Vi kan se dette på måten e-post skrives, hvordan spesielle filer blir skrevet, og hvordan innlegg ble skrevet i den forige Twikien. Vi liker personlig stil! Når det er sagt så må dokumenter, som alle kan skrive og mange kan lese, utformes enhetlig for å fremstå som mere profesjonelle. Det vil også lede til mindre "skribling", færre duplikater, mindre frustrasjon, og en hyggeligere opplevelse av arbeidet.

Dersom du ikke er i stand til, eller ikke villig til å følge disse retningslinjene som her er fastholdt, så ber vi deg respektfult om å avstå fra å redigere noen dokumenter i denne wikien.


Innhold

Endre sider

Oppsummer dine endringer

Skriv en kort liten redigeringsoppsumering i det lille feltet under redigeringsfeltet. Du kan bruke stikkord for å beskrive endringene som beskrevet i oppsummeringsbeskivelsen.

Forhåndsvis før du lagrer

Når du er ferdig, så klikk Forhåndsvisning for å se hvordan dine endringer ser ut før du gjør dem permanente. Gjenta forhåndsvisning/redigeringsprosessen til du er fornøyd, så kan du klikke på Lagre siden så vil dine endringer bli oppdatert umiddelbart.

Signer dine kommentarer på diskusjonssidene

På diskusjonssidene bør du signere din kommentar med fire tilder (Tv 11:29, 8 December 2008 (MST)).

Du bør "signere" dine kommentarer på kommunikasjonssider:

  • Tre tilder (~~~) viser brukernavnet ditt: Karl Wick
  • Fire tilder (~~~~) viser brukernavn plus dato/tid: Karl Wick 07:46, 27 November 2005 (UTC)
  • Fem tilder (~~~~~) viser dato/tid alene: 07:46, 27 November 2005 (UTC)

Flat Layout

I denne wikien, finnes det ikke noe hierarki i sidenavn og URL, dette betyr:

  • Sidetittelen er også sidens navn
  • Unngå å bruke {{title}} da dette ikke blir sett som en tittel av søkemaskiner.
  • Bruk kategorier (og underkategorier) for å gruppere sider

Ikke slik : 

Title : Releases/Mandriva/2007/Errata
{{title|Mandriva 2007 Errata}}
This is the errata of Mandriva 2007

Men slik: 

Title : Mandriva_2007_Errata
[[Category:Errata]][[Category:2007]]
This is the errata of Mandriva 2007

For tittelen er, '_' og ' ' ekvivalent.

Valg av tittel

Når du velger en tittel for en ny side, så tenk deg godt om. En tittel må :

  • være kort uten fyllord. Tenk på hvordan du vil lenke til den fra andre sider (..., les [[Mandriva Linux 2007 Errata]]....)
  • inneholde 'Mandriva' + release nummmeret KUN når innholdet spesielt gjelder releasen. Ikke bruk "Virtualisering på Mandriva 2009" hvis det gjelder for alle versjoner av Mandriva. Og ikke bruk "Virtualisering på Mandriva", da det er opplagt at denne wikien er om Mandriva. "Virtualisering" er tilstrekkelig.
  • representere emnet for hele siden

For hjelp, så kan du forestille deg hva du ville skrive i Google for å komme til denne siden.

God praksis

For søkemotorer

  • ikke bruk '=' for å lage tittler, start med '==' : når siden blir konvertert til html kommer wiki til å lage h2 istedenfor h1, slik at tittelen på siden blir den eneste store skriften. Innholdstabellen vil automatisk forstå dette.
  • for å lage nye sider lager du en lenke fra en annen side i wikien (dersom du ikke finner en passende side, så bruk din personlige side). Dette gjør siden lesbar for søkemotorer, men også for andre mennesker, som da kan bruke lenken til den.
  • Legg til en passende kategori for en ny side helt fra starten av: på denne måten er det større sannsynlighet for at folk oppdager at det finnes en ny side.

For lesbarhet

  • Et emne per innlegg: Ikke lag en artikkel om "Grafiske programmer" der du inngående forklarer Gimp, Inkscape, etc. Lag en side per program og lenk til dem fra hovedartikkelen.
  • forsøk å lage en seksjonstittel eller undertittel per skjerm: det er lettere å lese når du har "store saker" å feste blikket på.
  • ikke forsøk å bruke egne farger og layouts. På denne wikien, med noen få unntak som hovedsiden, må alle sidene ha de samme fargene og den samme layouten (har bøker forskjellig skrift på hver side?). Dersom du bruker en farge som du ønsker for teksten din så kan denne bli stygg når CSS endres i fremtiden, eller føre til uventede resultater. (tips : førsøk i en {{titel}} å bruke en lenke på en blå bakgrunn).

Samarbeid

  • lag lenker til ikke-eksisterende sider (dette kan gjøres med [[IPv6]]..., når siden IPv6 ikke eksisterer) : dette vil vises hvilke sider som mangler i Etterspurte sider
  • ikke nøl med å lage en liten side på 5 linjer : dette kan bli starten på en samarbeids-side. Folk er mindre redde for å forbedre en side enn å starte den fra "skrætsj".
  • start med innholdsfortegnelsen : du må da tenke gjenom emnet, og selv om det ikke er ferdigstillt så vil folk forstå hva du ønsket å gjøre og kan starte med å fylle ut seksjoner på siden.
  • ikke lenk til seksjoner eller underseksjoner på siden: en lenke til RPM_Opplæring#fra_kilden vil bli brutt hvis seksjonen omdøpes til RPM_Opplæring#fra_upstream_kilder.

Stiler og maler

Stil og måten dokumenter skrives på er ekstremt viktig. Noen bruker wiki syntax, noen foretrekker HTML syntax. Noen lager sider som "System-administrasjon" mens andre bruker kortnavn som "Sysadmin" eller "Systemadministrasjon".

Noen vil bruke paragraf-tags der det ikke er nødvendig, andre vil bruke linjeskift-tags der det ikke er nødvendig, etc. Noen foretrekker mye fet eller italic skrift. Dette er saker som trengs å normalisere, slik at Layout og utseendet til innholdet blir enhetlig fra side til side.

Maler

MediaWiki tillater bruk av maler, som gir enhetlig styling til tekst, som vi ønsker å fremheve. Maler skrives slik:

{{Mal|tekst}}

Så for å bruke tittelmalen for å fremheve beskrivelsen eller tittelen på siden, må du bruke:

{{titel|Dette er tittelen på siden}}

De følgende maler er tilgjengelig og må brukes:

Display all templates available for this Wiki

Mange av disse er oversatt og finnes under sitt norske navn på Spesial:Mest_brukte_maler. Bruk disse før du henter en mal (som mangler her) fra de engelske sidene.

Disse malene eksisterer for å bli brukt og bør brukes konsekvent og på den måten som beskrevet ovenfor. De blir brukt for å skape visuelle holdepunkter for saker som blir diskutert og sørger for at saker som fil eller pakkenavn fremheves, noe som gjør det letter å lese siden.

Obs: Dersom en mal inneholder et er lik tegn (=) eller pipesymbolet (|) så vil det ikke fungere med mindre de blir inhyllet i <nowiki> og </nowiki>

Stil

Her er noen holdepunkter som du bør være oppmerksom på mht stilen til en redigert side:

  • Du trenger ikke å bruke paragraf <p> tagen; bare lag en tom linje mellom paragrafene så vil wikien autoformatere; på samme måte bør du unngå <br>.
  • Forsøk å unngå å bruke wikitekstformatene for fet og kursiv (''' og ''); Bruk HTML kodene (<b> og <i>) istedet, da dette gjør det my enklere å se hvilken stil som gjelder.
  • Mellomrom mellom overskriftstagene er viktige; det bør bære nøyaktig 1 tom linje foran dem (Stilarkene hjelper til mes riktige avstander, så ekstra mellomrom vil bare forstørre overskriften).
  • Ikke putt lenker til andre sider i en overskrift: lenker til andre sider hører hjemme i teksten, ikke i overskriften.
  • Ikke bruk overskrifter som "higlighters" eller for å lage en liste; overskrifter genererer automatisk en innholdsfortegnelse, og bør brukes til å dele opp teksten i logiske seksjoner, ikke til å lage formaterte lister.
  • Når du lenker til en annen artikkel i wikien, så ikke bruk wikiens fulle sti, bruk [[Wiki utformingsregler|Wiki-stil]] (istedet for f.eks. [http://wiki.mandriva.com/no/Wiki utformingsregler Wiki-stil] da dette vil være sikrere i forhold til endring av domenenavn ol.
  • Vennligst ikke bruk <a href=...> i sidene, bruk standard [http://foo en eller annen tekst] i stedet.
  • Det bor være 1 tom linje som skiller blokker av tekst; dette gjør det lettere å lese den når man redigerer; så sørg for at det er 1 tom linje mellom avsnittene, mellom avsnitt og <pre> tager, lister, etc.

Inter-Wiki Lenker

Du kan bruke Inter-Wiki lenker til andre språk og til eksterne sider, som Bugzilla. F.eks. å bruke:

[[:bugz:12345]]

vil lenke til http://qa.mandriva.com/show_bug.cgi?id=12345 automatisk. Du kan pynte på dette ved å bruke [[:bugz:12345|Bug #12345]] ellers vil lenken se slik ut: bugz:12345. Dette er å bruke "bugz" inter-wiki navnet for å representere bugzilla urlen. Du kan istedet velge å bruke den mer jålete {{bug|12345}} malen istedet, men hvis du ønasker å bruke din egen tekst, så er det bedre å bruke inter-wiki lenken da bug-malen ikke gir deg noen muligheter for å skape ditt eget lenkenavn (f.eks. [[:bugz:12345|Dette var en stygg bug]]).

Der inter-wiki lenker er tilgjengelige, bør du bruke dem. Slik fanger vi opp at adressen senere endres (f.eks at bugzilla ikke lenger er tilgjengelig på http://qa.mandriva.com) det handler om å endre ett innlegg i wikidatabasen og en mal, i motsetning til å potensiellt måtte endre hundrevis av individuelle lenker.

På samme måte bruker Oversettelse malen den samme inter-wiki lenkingen. For å lenke til den engelske versjonen av en side, bruker du Oversettelse malen med inter-wiki-lenken inne i den, slik:


{{Oversettelse|[[:en:KDE|Engelsk]]}}

Her spesifiserer "en" den engelske versjonen av wikisiden, kallt KDE i dette tilfellet. Denne vil føre deg til /en/KDE på nettstedet; f.eks; en:KDE. Språk som støttes foreløpig er:


  • de - Tysk
  • en - Engelsk
  • es - Spansk
  • fi - Finsk
  • fr - Fransk
  • it - Italiensk
  • ja - Japansk
  • no - Norsk
  • pl - Polsk
  • pt - Portugisisk
  • ru - Russisk
  • zh - Forenklet kinesisk
  • zh-tw - Tradisjonell kinesisk

I sin enkleste form ser inter-wiki lenken da slik ut [[:en:KDE|Engelsk]]

Syntax

Her er noen lenker angående wiki-syntax og hva du kan gjøre med MediaWiki:

Starte en ny side

Før du starter på en ny side så var sikker på at du har søkt nøye først før du anlegger den nye siden. Det er godt mulig at siden eksisterer og bør redigeres, heller enn å bli duplikert.

Dersom du trenger å anlegge en ny side, må du være klar over dens plassering i "treet" i henhold til reglene i Topic Layout. Dersom du anlegger en side feil, eller lager en toppnivå side, så vil noen måtte slette den eller flytte den, noe som bare frustrerer og skaper ekstraarbeid for andre.

Andre gode ideer som en kan merke seg finnes på Wikimedia's Starting a new page emne.

Fjerne eller endre navn på side

Vennligst ikke flytt eller endre navn på sider på egenhånd. Dersom du mener en side er på et sted den ikke hører hjemme send en mail til web-discuss-mailinglist med din oppfordring, så vil en av administratorene foreta flytting og eller sletting av siden, dersom det er påkrevet.

For administratorer så har Wikimedia god informasjon:

Kommunikasjonssider

Snakkesider er utmerkede resurser. Med Twiki så ble brukerkommentarene plasert i dokumentet i seg selv (som f.eks endringslog og hvem gjorde hva etc.). I Mediawiki er dette ikke påkrevet, men det frarådes helt og holdent. Brukerkommentarer distraherer lesingen av selve hovedinnholdet, og får siden til å se rotete og klossete ut. Snakkesider bør brukes istedenfor (snakkesider er også kjent som diskusjonssider). Disse sidene kan inneholde en endringslog over hvem som gjorde hvilke endringer, og de kan også inneholde brukerkomentarer til emnet, ønske om mer informasjon osv. Diskusjonssidene er tegnebrettet bak det virkelige innholdet.

I motsetning til Twiki er det ikke lenger nødvendig å vedlikeholde en "endringslog". Når du redigerer sider legger du nå inn en komentar i oppsummeringsfeltet (som; hva du gjorde eller endret og når det ble endret).

Se også på Engelske stileksempel for et eksempel på et dokument som illustrerer det som her er fastholdt.

Utvidelser

Vi diskuterer (på wiki-discuss) å inkludere flere utvidelser som kan hjelpe:

Hentet fra «http://wiki.mandriva.com/no/Wiki_utformingsregler»
Personlige verktøy
Fund the Mandriva Linux project
Andre språk