Om filsync
Filsync settes normalt opp med et git-repository som kilde, men egentlig kan hvilket som helst filomr?de brukes (forutsatt at det kan gj?res tilgjengelig for lesing av filsyncscriptene, som for tiden kj?res fra maskinen vortex-sync.uio.no). (Repoer i SVN er ogs? st?ttet, men dette er noe vi pr?ver ? fase ut.)
Filsync har st?tte for opplasting som Vortex-artikler for formatene rst (ReStructuredText), som er vanligst, og XHTML.
Andre formater blir lastet opp tilsvarende som ved bruk av en standard WebDAV-klient (skal fungere greit for bilder, pdf, doc, etc).
Filsync starter normalt hvert annet minutt hele d?gnet. Samme prosess deles mellom mange omr?der, slik at det kan oppst? noe forsinkelse ved stort endringsvolum.
Hvordan ta i bruk
Ta kontakt med
vortex-hjelp@usit.uio.no for oppsett. For uthenting fra git m? v?r systembruker har lesetilgang til repoet; p? github.uio.no gj?res dette ved ? legge inn som ?deploy key? en offentlig n?kkel som systembrukeren har den private motparten til. Tilsvarende brukes normalt brukeren sgml for skriving av innhold til Vortex. Denne brukeren m? ha lese og skriverett til omr?det som skal vedlikeholdes i Vortex.
Begrensninger
Rettigheter m? styres p? mappeniv?
Rettigheter skal bare settes p? mappeniv? i omr?der som synces. Grunnen er at i en del tilfeller kan scriptene slette et dokument og opprette det p? nytt (og da forsvinner eventuelle rettigheter satt for enkeltdokumentet).
Feilsituasjoner
N?r det oppst?r feilsituasjoner (f.eks. ugyldige rst dokumenter) blir normalt feilmeldingen lagt i selve dokumentet. Brukere som redigerer innhold m? selv sjekke at dokumentene blir riktige p? web.
Unng? helst manuelt vedlikeholdte dokumenter i mapper som er satt opp med filsync
N?r et omr?de (dvs. en mappe i Vortex) settes opp for filsync, b?r man i st?rst mulig grad unng? manuell redigering innenfor mappen (dvs. manuell redigering i Vortex admin). Det er helt OK ? endre f.eks. rettigheter og innstillinger for mapper, men det er fort gjort ? miste oversikten hvis man blander inn for mange manuelt vedlikeholdte dokumenter. Filsync scriptene vet bare om sitt eget innhold. Derfor vil manuelt opprettet innhold bli overskrevet ved navnekonflikt.
Unng? langvarig l?sing
Mens man arbeider med manuell redigering i Vortex admin oppst?r det ofte l?sing av innhold. Dette gjelder f.eks. ved redigering av en mappe, som f?rer til l?sing av mappen og alt innhold i mappen (rekursivt). L?sing hindrer filsync scriptene fra ? gj?re det de skal. I slike tilfeller kan scriptene ta en pause p? ca. en halv time f?r de pr?ver igjen.
Include st?ttes ikke
Include direktiver i rst st?ttes ikke.
rst
rst dokumenter konverteres til Vortex artikler. Hvis rst dokumentet ikke har tittel, brukes "Tittel mangler/Missing title".
Eksempeldokument
====================================
Demo av UiO rst til Vortex artikkel
====================================
.. uio-meta::
:responsible-name: Donald Duch
:responsible-email: d.duch@u.uio.no
:image: bilder/test.gif
.. uio-introduction::
Her er en ingress.
.. contents::
.. section-numbering::
Litt tidlig tekst
F?rste hovedavsnitt
=======================
Med litt tekst.
Andre hovedavsnitt
=======================
Med litt tekst ogs?.
Man kan bruke f?lgende spesial-directives
uio-introduction
uio-meta
uio-related-content
F.eks.:
.. uio-meta::
:responsible-name: Oddmund M?gedal
:responsible-email: oddmund@usit.uio.no
:published-from: 2006-11-21
:published-to: 2011-06-21T16:30:03
.. uio-introduction::
Her er en ingress.
- Her er en bullet i ingressen
- Og en til
- Og en som er rykket inn
- Og en til
.. uio-related-content::
Her er relatert innhold.
uio-meta opsjoner for rst dokumenter
json: default true for rst, dvs. om det skal lagres som artikkel
published: default true, hvis den er satt, overstyrer den datoene published-from/published-to
published-from: ISO8601_timestamp
published-to: ISO8601_timestamp
author:
image:
image-caption:
responsible-name:
responsible-email:
media-file:
tags:
navigation: default left-menu, mulige verdier left-menu, back-link, no-navigation
Versjon 1 (default):
hide-right-column: default true
(Dette kan v?re litt forvirrende, fordi innstillingen har endret navn underveis i Vortex. I Vortex heter dette n? "Vis i h?yrekolonne" som blir omvendt, og som derfor har default "nei".)
Versjon 2 (m? velges ved oppsett):
show-additional-content-right: default false
responsible-url: