Dokumentasjon

Hvordan bruke Wiki?

Dette er den nye Wikien til ITK; den er selvutviklet på stort sett én kveld i Perl, med PostgreSQL som backend. ITK har iløpet av høsten 2006 lekt en hel del med features til wikien og spredt den til andre gjenger på huset. Etterhvert som den utvikles vil det komme oppdatert informasjon. Her følger noen formateringsregler, se wikisyntaks for eksempler

Man får nodelinker ved å bruke [ og ] rundt ord, så [Link] blir til Link, wikien støtter ogå [tittel på link | Link] som blir tittel på link.
Eksterne linker fungerer også, bruk [URL] eller [tittel på linken | URL]. (En del tegn, som underscore, kan du ikke bruke i linker.)
Bruk [#header] for å linke til !header internt i noden, evt [tittle på link | #header]
Bruk [image | bildefilnavn] for å vise et bilde fra /dok-filer (varierer fra wiki til wiki).
Bruk [file | bildefilnavn] for å lenke til en fil under /dok-filer (varierer fra wiki til wiki).
Bruk \[ og \] dersom du skal ha klammer uten å lage link, \\ for å lage en backslash for seg selv, osv..
For å legge til en ny node, bare lag en link og prøv å følge den, så blir du tatt direkte til edit-siden hvor du kan redigere som du vil; noden blir automatisk opprettet idet du lagrer den første gang. Dersom du sletter all tekst i en node, blir noden automatisk fjernet (men eksisterer selvsagt fortsatt i CVS).
Bruk * for å lage uordnede lister. # for ordnede lister.
Definisjonslister (typisk ordforklaringer m.m.) lages ved å skrive termen din, så en newline, og så forklaringen. Typisk "Wiki:\nEt fint system for å oppbevare og redigere informasjon."
Du har tilgang til fet tekst (*tekst*), kursiv (_tekst_) og monospace (=tekst=).
Tabeller lages ved å skrive | celle1 | celle2 | celle 3 | osv., med linjeskift for hver ny rad. | *celle 1* | *celle 2* | osv. lager overskrifter.
Du får blockquote ved å plassere en ">" Først på linjen(e).

Hvordan legge inn bilder?

Skriv image og trykk på opplastingslinken etter du har sjekket inn endringene dine.

Hvorfor en wiki?

For å få lavest mulig terskel på å legge ut og vedlikeholde dokumentasjon. Ser man en mindre feil, kan dette bokstavelig talt rettes på ti sekunder. Skal man legge ut ny dokumentasjon, kan man knote ned noe kjapt og så forbedre det inkrementelt. Dokumentasjon burde ikke skrives i én slump, men være et pågående prosjekt som del av de prosjektene man holder på med.

Dessuten har man versjonering så langt tilbake man ønsker, og en del andre fine fordeler.

Hva er alle disse greiene nederst?

Det meste burde være ganske åpenbart:

"Sist endret" er datoen noden ble endret sist.
"Revisjon" er revisjonen til noden; begynner stort sett på 1 og teller oppover til uendelig.
"Se alle tidligere revisjoner" lar deg se alle tidligere revisjoner (doh! :-) ) og forskjeller mellom revisjoner.
"Totalt:" viser hvor mye råtekst det er i alle noder til sammen (ikke inkludert gamle versjoner, selvsagt).
"Rediger" redigerer noden. Hvem som helst kan gjøre dette, uten passord.

Men da kan jo hvem som helst ødelegge alt!

Ja, men da er det bare å rulle tilbake en gammel, fungerende versjon. Wikipedia har gjort dette i årevis, med få problemer.

Hvorfor lage nok en wiki?

Fordi det som finnes der ute tildels er alt for ekkelt.
Fordi det gikk raskere å skrive noe selv enn å finne noe der ute som var fint og greit å bruke :-)
Fordi det er mye lettere å få noe tilpasset våre behov.
Fordi vi kan! ;-)

Per dags dato er det ingen planer om å slippe systemet for allmenn bruk (polering, generalisering og vedlikehold tar tid, og det finnes jo som kjent ørten wikisystemer der ute allerede), men hvis folk er interessert kan de sikkert sende en mail og få tilgang til CVS-repositoryet med koden i. :-)

Hvorfor migrerte man fra CVS til PostgreSQL?

ITKWiki var opprinnelig CVSWiki, dvs. en wiki som brukte CVS som backend. (Hadde den vært skrevet i dag med samme tankegang, hadde man nok brukt Subversion, men det er en annen sak.) Tankegangen var:

ITKere foretrekker ordentlige editorer (vim/emacs) i stedet for editboksen i en nettleser.
CVS gir oss mye gratis mht. versjonskontroll, diffing, merging osv.

Det viste seg i praksis dogat CVS kostet litt mer enn det smakte (dvs. wikien fungerte fint, men det var litt knot kodemessig, og vanskelig å legge til en del nye funksjoner). Grunner til å bytte over til en databasebasert lagring var:

Ingen brukte noe annet enn webinterfacet uansett, så manuell inn-/utsjekking var ikke så nyttig som man hadde trodd. (Merk: Mye lavere terskel for å gjøre noe på webinterfacet => viktig!)
Det er ingen ordentlig måte å kontrollere CVS programmatisk på – for å få innsjekkinger med merging osv. riktig måtte hver nye editerings-sesjon sjekke ut et temporært repository, skrive til dette, gjøre cvs up, merge osv.. Dette krevde låsing av CVS-treet underveis m.m., og var litt mye kode og litt lite pent. (spotkunnskap: "apt-get install python2.3-subversion" for å kunne gjøre akkurat dette med SVN)
Mergingen kan gjøres med verktøyet diff3 uansett (hvilket vi nå gjør, selv om det ikke er 100% stabilt alltid).
Håndtering av auksillærinformasjon (revers-lenker, fulltekstsøk, sider som ikke eksisterer, changelog m.m.) er vanskelig med flatfiler, men nærmest trivielt med en relasjonsdatabase.
Bruk av en database gir oss bedre ytelse i og med at man slipper å gå via en pserver-protokoll osv. hele tiden.

Ulempene eksisterer, dog; det er f.eks. mye vanskeligere å ta med wikien på tur. Noen får skrive archwiki e.l., så kanskje noen av problemene ville forsvunnet :-P

Lenker: Start, arkiv, itkwiki, til nye itkere, wikiintern