Filsync av innhold (deriblant RST) til Vortex

Filsync til Vortex gjør det er mulig å vedlikeholde dokumenter utenfor Vortex, og så få alle endringer synkronisert vil Vortex.

Om filsync

Filsync settes normalt opp med et SVN-repository/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).

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.

Det er også mulig å bruke filsync til manuell opplasting av et fil-tre.

Hvordan ta i bruk

Ta kontakt med vortex-hjelp@usit.uio.no for oppsett. Med mindre det er spesielle sikkerhetsbehov brukes normalt Unix brukeren bsdsvn for uthenting fra svn (litt annerledes for git). Denne brukeren må derfor ha tilgang til å lese fra SVN-repositoryet som skal brukes som kilde. 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: 

 

Publisert 1. okt. 2012 11:09 - Sist endret 10. nov. 2016 14:10