Publiceringsregler defineras på servern och används för att tillåta användare att
schemalägga händelser såsom publiceringar, avpubliceringar etc. Schemaläggningen görs med hjälp av Publicera-dialogen (se ovan). Filen "publishrules.xml" definierar alla
regler, d.v.s. hur Publicera-dialogen skall se ut och bete sig, och vilka defaultvärden som fylls i för olika tidpunkter.
En publiceringsregel talar om vad som ska hända vid en viss tid. En regel av typen
"publicering" måste finnas i "publishrules.xml", d.v.s. en regel med händelsen "publish".
Struktur
Övergripande XML-struktur:
Antalet publiceringsregler är valfritt, men Publicera-dialogen bör inte innehålla mer än 2-3 regler (tider att fylla i).
Regler
Varje regel måste definieras på följande tre sätt:
• "name" är namnet på regeln. Det visas inte i Publicera-dialogen men används som nyckel, vilket innebär att det inte bör ändras efter det att regeln börjat användas,
• "displayname" är den text som visas bredvid kryssrutan i Publicera-dialogen, t.ex.
"Från" eller "Till".
• "description" är den text som visas under "displayname" i Publicera-dialogen och som talar om vad som kommer att ske vid den angivna tidpunkten.
Ett ytterligare alternativ kan användas:
• Om "mandatory" ges värdet "true" kommer regeln att vara obligatorisk att fylla i.
Tider
I publiceringsregler används olika tidangivelser med hjälp av "time". "time" används normalt inte i en "från" regel då detta skulle innebära att publicering inte kan ske omgående. I en "bästföre"-regel kan detta dock användas med fördel. "time" definierar en standardtid som kommer att fyllas i vid publicering. Tiden definieras som en
tidsdifferens relativt en annan tid, t.ex. "från", vilket i exemplet nedan innebär att
<?xml version='1.0' encoding="ISO-8859-1"?>
<rule name="from" displayname="Skall publiceras vid senare tillfälle>
<description>
Sidan kommer att vara publicerad från och med:
• I taggen "relative" talar värdet i "to" om till vilken regel som tiden ska vara relativ.
"value" talar om hur tiden är relativ, bakåt i tiden eller framåt. Godkända värden är
"before" och "after".
• "diff" och "value" anger hur många dagar som skall gälla mellan tidpunkten i regeln som satts i "relative" och den aktuella regeln.
• "max" och "value" talar om max antal dagar som kan anges i tidsfälten i dialogen för den aktuella regeln. "max" bör inte sättas till mindre än "diff", vilket kommer att innebära att tiden måste ändras för att publicering ska kunna ske.
• "period" används endast vid upprepade notifieringar. "value" kan vara MONTHLY, WEEKLY, DAILY, EVERY12HOURS eller HOURLY, och "count" talar om hur många meddelanden som ska skickas.
Ovanstående "time"-definition kommer att notifiera användaren en gång varje dag i fem dagar.
Händelser
I varje regel definierar taggen "actions" vad som kommer att inträffa. Flera händelser kan användas i samma regel, t.ex. "unpublish" för avpublicering och "notify" för att notifiera användare om den aktuella händelsen.
• Publicering
Den enklaste händelsen är publicering "publish" vilken kommer att publicera aktuell sida. En sådan regel måste finnas i filen.
<time>
<relative to="from" value="after"/>
<diff value="180"/>
<max value="180"/>
</time>
<time>
...
<period value="DAILY" count="5"/>
</time>
<actions>
...
<publish/>
</actions>
• Avpublicering
Avpublicering av aktuell sida.
• Arkivering
Arkivering av aktuell sida. Sidan och dess underliggande sidor kommer att flyttas om
"move" är satt till "true", annars kopieras sidan till arkivet, vilket innebär att arkivering kan användas för automatisk versionsarkivering vid t.ex. avpublicering.
"target" talar om vilket arkiv som skall användas. Denna parameter är dock valfri då standardarkiv sätts under Sidegenskaper/Publicering/Arkiveringssökväg, som då kommer att styra vilket arkiv som ska användas.
• Notifiering
Notifering används för att notifiera användare via e-post om att händelser såsom avpublicering, bästföre datum osv har inträffat.
o "recipients" anger vem som skall notifieras. Två nyckelord kan användas:
MODIFIER och EDITORS.
MODIFIER kan endast användas om underliggande katalogtjänst innehåller e-postadressen för den användare som senast har ändrat på sidan.
EDITORS definieras under Sidegenskaper/Redaktörer, och då finns
e-postadressen lagrad där.
META[...] kan användas för att användaren själv vid publicering ska kunna tala om vem som ska notifieras via ett metadatafält. Syntax: META[<metadatafältnamn>].
Fler än en mottagare kan anges.
o "time" används för att tala om när notifieringen ska skickas (se avsnittet "Tider"
ovan.)
<actions>
...
<unpublish/>
</actions>
<actions>
...
<archive move="true" target="/arkiv1"/>
</actions>
<notify>
<recipients>
META[Sidansvarig]
...
</recipients>
</notify>
o "msg" är själva e-postmeddelandet som skall skickas. "subject" är ämnet i
meddelandet och själva texten anges mellan "<msg>" och "</msg>". Meddelandet kommer också att innehålla en länk till aktuell sida. Sidans adressprefix kan
definieras av "urlprefix", vilket vanligtvis är adressen till webbplatsens startsida.
Exempel
I exemplet nedan är tre publiceringsregler definierade:
1. En Från-regel, där sidan publiceras vid den tidpunkt som skrivs in i tidsfälten i dialogen. Frånvaron av en "time"-tagg gör att det är möjligt att publicera sidan omgående.
2. En Bäst före-regel, där sidan blir inaktuell vid den tidpunkt som anges i tidsfälten.
Förvalt värde i fälten är 180 dagar efter den tidpunkt som satts i Från-regeln. Sidan förblir dock publicerad.
Bäst före-regeln är obligatorisk, d.v.s. det går inte att kryssa ur Bäst före-rutan i Publicera-dialogen.
Den som senast ändrat sidan notifieras 5 dagar innan sidan passerar Bäst före-tidpunkten.
3. En Till-regel, där sidan avpubliceras vid den tidpunkt som anges i tidsfälten. Förvalt värde i fälten är 180 dagar efter den tidpunkt som satts i Från-regeln.
<notify>
<recipients>
MODIFIER EDITORS
META[...]
</recipients>
<time>
<relative value="before" />
<diff value="5"/>
</time>
<msg subject="Inaktuell sida"
urlprefix=http://www.server.se>
Sidans bäst före-datum håller på att gå ut.
</msg>
<?xml version='1.0' encoding="ISO-8859-1"?>
<publishrules>
<rule name="from" displayname="Ska publiceras vid senare tillfälle">
<description>
Sidan kommer att vara publicerad från och med:
</description>
<relative to="from" value="after" />
<diff value="180"/>
<max value=”180”/>
</time>
<description>
Sidan kommer att vara inaktuell efter detta datum
</description>
Sidans bästföre datum håller på att gå ut
</msg>
<relative to="from" value="after" />
<diff value="180"/>
</time>
<description>
Sidan kommer att avpubliceras vid följande datum
</description>
<actions>
<unpublish/>
</actions>
</rule>