|
Kvalitetssikring - Al Mashriq 97
Denne siden inneholder QA-rutiner for Al Mashriq-prosjektet, våren 1997. Den skal fungere som en referanseside for utviklerne i prosjektet, og er ment til å besvare praktiske spørsmål under utvikling og vedlikehold av prosjektet.<
p>
Dokumenter
Temporære
Dokumenter som er under utvikling bør lagres midlertidig under /www/almashriq/htdocs/temp. Denne katalogen er nåbar fra
http://almashriq.hiof.no/temp/
Filer som lagres midlertidig i dewey-systemet skal lagres med filnavn .tmp eller tmp. Dette for at ikke slike filer skal indekseres av søkesystemet.
Ferdigutviklede
Dewy-decimal-systemet skal benyttes ved innlegging av nye sider. Det kan i endel sammenhenger være vanskelig å finne ut hvor i hierarkiet dokumentet skal ligge, spesielt om det faller kan falle inn flere sider. En mu
lighet er å plassere dokumentet ett sted, og bruke symolic links fra de andre områdene. Børre avgjør i tvilstilfelle.
Maler
Det finnes egne html-standarder for de ulike temaene. Disse skal brukes når man skal lage nye dokumenter av samme type som finnes fra før. Malene ligger lagret på /www/almashriq/htdocs/admin/templates/.
- Standard blank side (/almashriq/admin/templates/standard.html)
- Standard topp-tekst (/almashriq/admin/templates/top.html)
- Standard bunn-tekst (/almashriq/admin/templates/bottom.html)
- Standard "moved" (/almashriq/admin/templates/moved.html)
- Fafo-rapportene
Fafo-rapportene har gjennomgående likt design. Det spesielle ved Fafo-rapportene er at de skal ha en standard topp- og bunntekst.
- Mal (/almashriq/admin/templates/fafo.html)
- Oversiktsfil (hvor nye rapporter linkes opp fra)
- Lagres under /.../almashriq/general/300/320/327/fafo/reports/
- Aramco World
Aramco World legges ikke under egne områder men artiklene derifra legges på plass etter hvor de hører hjemme.
- Mal (/almashriq/admin/templates/aramco.html)
Diverse
- Weblint kjøres på alle nye html-sider som lages, samt ved større endringer i et dokument. Kommandoen er weblint [htmldokument]. Feilmeldinger av typen unknown element ... kan ignoreres.
- Relative linker skal benyttes i alle referanser
- Alle dokumentene bør inneholde en skjult tag som forteller om hvem som editerte filen sist.
- ISO spesialkarakterer
- Nye dokumenter linkes opp fra tilhørende hovedfilene og legges til filen New additions/changes (~/almashriq/base/latest.html).
Programmer/script
WebXref
Webxref er et program som sjekker interne og eksterne linker i html-dokumenter. Vi har lagd et script (admin/webxref/webxref_all) som kjører webxref hver uke. Dette skjer ved hjelp av cron hver mandag. Output fra webxref blir lagret i fila: http://almashriq.hiof.no/admin/webxref.html. Denne fila burde sjekkes jevnlig for å finne feil med linker.
Temporære
Programmer og script under utvikling lagres under ~/temp, evt. under brukernes egne kataloger på hjemmeområdet (f.eks ~/simen/).
Ferdigutviklede
- CGI-script - /www/cgi-bin/
- Inline-kode - /www/cgi-bin/
- Programmer (f.eks glimpse, sclnews-script) - ~/admin/, helst i underkataloger med beskrivende navn (~/admin/search/).
Cronjobber legges inn i crontab, ~/admin/crontab, og registreres med kommandoen "crontab ~almash/admin/crontab". Script tilknyttet cronjobber legges i tilhørende kataloger under admin (f.eks ~/admin/search/glimpse.helper)
|
