4. Nieuwsbrieven

Auteur Jan Corthouts
Aanmaak 02 jan 2006
Aangepast door Tom De Mey
Aangepast op 02 maa 2015
Oud BVV nr 2126

4.1. Abstract

Dit document beschrijft het gebruik van nieuwsbrieven in Brocade. Vanaf release 3.00 werd hiervoor een nieuwe toepassing gemaakt, gestuurd door de nodige meta-informatie.

4.2. Algemene informatie

Een nieuwsbrief wordt geïdentificeerd door een unieke identifier. In Brocade kan je dus verschillende nieuwsbrieven naast elkaar opzetten. Vervolgens kan je nieuwsitems toevoegen aan nieuwsbrieven. Je kan hetzelfde bericht in diverse nieuwsbrieven publiceren. Je kan desgewenst per nieuwsbrief ook aangeven welke verschillende rubrieken erin bestaan. Op die manier kan je naast het chronologisch doorlopen van de nieuwsitems (cfr. wat in de oorspronkelijke changelog gebeurde) ook alle nieuwsitems van een bepaalde rubriek opvragen.

4.3. Meta-informatie nieuwsbrief

Ga naar de toepassing Brocade ‣ Nieuwsbrieven ‣ Nieuwsbrieven [link] om een nieuwe nieuwsbrief te maken of om de parameters van een bestaande nieuwsbrief aan te passen.

Identificatie
Kies een korte identifier (enkel kleine letters; geen cijfers; geen leestekens).
Benaming
Geef een benaming voor de nieuwsbrief. Deze benaming wordt gebruikt in het overzicht van de nieuwsbrieven.
Scope
Geef (optioneel) een annotatie die iets vertelt over het doel en de opzet van de nieuwsbrief.
Benaming (N E F D U)
Geef een benaming (in de diverse talen) aan de nieuwsbrief. Deze benaming wordt gebruikt bij publicatie van de nieuwsbrief in de desktop.
Begeleidende tekst (N E F D U)

Geef (optioneel) een begeleidende tekst. Deze tekst wordt ook getoond bij publicatie van de nieuwsbrief in een desktop. Voorbeeld:

Welkom op de nieuwsbrief voor de personeelsleden van de UA-bibliotheek. Wil je een
bericht toevoegen? Stuur titel en tekst naar helpdesk@library.uantwerpen.be .
Volgorde rubrieken
Som in volgorde de rubrieken op die je in de nieuwsbrief wenst. De rubriek zal enkel getoond worden indien er voor de rubriek ook berichten zijn.
CSS

Geef de stijlkenmerken voor de diverse classes van de nieuwsbrief. Voorbeeld:

a:link {color:#336699; }

a:visited {color: #336699;}

a:link:hover, a:visited:hover {text-decoration: underline; }

.newsletter_headers {width: 200px;
                     background-color: #ECF0F7;
                     font-size: 8pt;
                     padding: 4px 4px 4px 4px;
                     text-align: left;
                     float:left;}

.newsletter_header {}

.newsletter_title {font-weight: bold;
                   font-size: 12pt;
                   margin-bottom: 1em;}

.newsletter_text {background-color:#F0F0F0;
                  margin-bottom: 1em;}

.newsletter_items {margin-left: 220px;}

.newsletter_item {margin-bottom: 1.5em;
                  font-size: 9pt;}

.newsletter_item_title {color: #78032f;
                        font-weight:bold;
                        font-size: 10pt;}

.newsletter_item_header {font-weight: bold;
                         font-size: 8pt;}

.newsletter_item_info {color: #999999;
                       font-size: 8pt;}

.newsletter_item_body {margin-top: .5em;
                       margin-bottom: .5em;}
Reply-to e-mail adres
Het e-mail adres dat je hier ingeeft wordt bij elk gepubliceerd item toegevoegd als het afzendadres. Je kan dit algemene reply-to adres ook overschrijven ter hoogte van het nieuwsitem zelf (cfr. verder).
Maximale ouderdom van bericht in dagen
Geef aan wat de maximale ouderdom van een bericht mag zijn. Is het bericht op een gegeven ogenblik ouder, dan wordt het niet meer in de nieuwsbrief gepubliceerd. De waarde die je hier opgeeft, is een standaard waarde. Je kan ook ter hoogte van een individueel nieuwsitem de publicatieperiode aangeven.
Volgorde items
Kies tussen jongste eerst (standaard waarde) of oudste eerst.
RSS aanbieden
Indien deze optie is aangevinkt dan verschijnt het RSS logo bij publicatie in de desktop. De gebruiker kan vervolgens de RSS-link gebruiken in zijn RSS-client (mail, browser) om op de hoogte te blijven van het bibliotheeknieuws.

4.4. Meta-informatie rubriek

Je kan bij het aanmaken van een nieuwsbericht aangeven in welke rubriek het bericht moet worden gepubliceerd. Deze rubrieken worden beheerd met de toepassing Brocade ‣ Nieuwsbrieven ‣ Rubrieken [link]. Rubrieken worden gebruikt over de verschillende nieuwsbrieven heen.

Identificatie
Kies een korte identifier (enkel kleine letters; geen cijfers; geen leestekens).
Benaming
Geef een benaming voor de rubriek. Deze benaming wordt gebruikt in het overzicht van de rubrieken.
Scope
Geef (optioneel) een annotatie in die iets vertelt over het doel en de opzet van de rubriek.
Benaming (N E F D U)
Geef een benaming (in de diverse talen) aan de rubriek. Deze benaming wordt gebruikt bij publicatie van de nieuwsbrief in de desktop.

4.5. Meta-informatie nieuwsitem

Eenmaal je nieuwsbrief en (optioneel) de rubrieken zijn gedefinieerd, kan je nieuwsitems gaan publiceren. Gebruik daarvoor de toepassing Brocade ‣ Nieuwsbrieven ‣ Nieuwsitems [link]. Elk nieuwsitem krijgt een uniek volgnummer. Per nieuwsitem kunnen volgende data worden ingegeven.

Aangemaakt
Dit veld wordt automatisch ingevuld door het systeem met de naam van de persoon die het bericht invoerde en het tijdstip waarop dit gebeurde.
Behoort tot
Geef hier de nieuwsbrief en (optioneel) de bijhorende rubriek waarin het bericht moet worden gepost. Je kan dit veld herhalen: op die manier kan je hetzelfde bericht in diverse nieuwsbrieven publiceren.
Geldig vanaf
Geef de datum in vanaf wanneer je een bericht in de nieuwsbrief zichtbaar wil maken. Vul je niets in dan wordt het bericht meteen zichtbaar.
Geldig tot
Geef de datum in tot wanneer een bericht in de nieuwsbrief zichtbaar moet blijven. Vul je niets in dan blijft het bericht zichtbaar voor de periode zoals die is ingegeven ter hoogte van de nieuwsbrief (cfr. boven). Is ook daar niets ingegeven dan blijft het bericht altijd zichtbaar.
Discussielijst
Geef hier (optioneel) de identifier van een discussielijst in. In dat geval wordt het bericht bij registratie niet enkel in de nieuwsbrief op de desktop gepubliceerd, maar krijgen alle abonnees van de discussielijst het nieuwsbericht ook in hun mailbox. Je kan meer dan één discussielijst opnemen.
Reply-to e-mail adres

Geef hier (optioneel) een e-mail adres in. Het e-mail adres dat je hier ingeeft wordt dan als het afzendadres gepubliceerd. Brocade hanteert volgende logica voor publicatie van het reply-to adres:

  • Reply-to adres zoals ingegeven bij het nieuwsitem
  • Indien dit niet werd ingegeven wordt het adres genomen zoals ingegeven ter hoogte van de nieuwsbrief
  • Indien dit niet bestaat dan wordt het e-mail adres genomen van de auteur van het bericht (Brocade user).
Titel (N E F D U)
Geef een titel voor het bericht. Doe dit in verschillende talen indien je desktop ook meertalig is.
Inhoud (N E F D U)

Geef de inhoud van het bericht. Doe dit in verschillende talen indien je desktop ook meertalig is. Je kan hierbij gebruik maken van Markdown syntaxis. Markdown is een beperkt geheel van afspraken die toelaat om op eenvoudige wijze teksten te schrijven die bedoeld zijn voor publicatie op het web. Markdown werkt niet met HTML-tags maar met gewone “plain text”. Deze “plain text” wordt na ingave in Brocade omgezet naar HTML. Met Markdown kan je gemakkelijk opmaak (vet, cursief) invoegen, structuur aanbrengen (opsommingstekens, titels) en links (naar afbeeldingen of andere bronnen op het internet). Voorbeelden:

*cursief* ==> cursief

**vet** ==> vet

***vet en cursief*** ==> vet en cursief

* eerste punt
* tweede punt
* derde punt
    wordt
- eerste punt
- tweede punt
- derde punt

1 eerste punt
2 tweede punt
3 derde punt
    wordt
- eerste punt
- tweede punt
- derde punt

Een [voorbeeld-link](http://voorbeeld.be/ "Optionele titel") in een zin.
wordt

Een `voorbeeld-link` in een zin.

4.6. Publicatie in desktop

Om een nieuwsbrief in een desktop te publiceren doe je het volgende:

  1. Maak een menu-entry met als opstart url <mcgi routine="Entry:bnewdesk">&RDnewsl=nieuwsbrief-id. Vervang nieuwsbrief-id door de identifier van je nieuwsbrief. Zet deze menu-entry (optioneel) op hidden, zodat deze niet wordt getoond in de interface. Geef deze menu-entry een unieke roepcode, bijvoorbeeld newsbib.
  2. Ga naar Brocade ‣ Desktop ‣ Desktop - beheersfuncties ‣ Beheer services [link]. Definieer een service met als applicatie-url de unieke roepcode van de menu-entry die je net definieerde (newsbib uit ons voorbeeld van hierboven).
  3. Voeg deze service nu toe in de gewenste desktop.

4.7. Adressering

Je kan een nieuwsbrief op volgende wijzen ook adresseren (bv. vanuit een statische HTML-pagina)

  • Naar een nieuwsbrief binnen de standaard desktop: http://dev.anet.ua.ac.be/newsletter/adbib-news
  • Naar een nieuwsbrief binnen een gespecificeerde desktop: http://dev.anet.ua.ac.be/newsletter/ua/adbib-news
  • Naar een newsitem binnen de standaard desktop: http://dev.anet.ua.ac.be/newsletter/adbib-news/5788
  • Naar een newsitem binnen een gespecificeerde desktop: http://dev.anet.ua.ac.be/newsletter/ua/adbib-news/5788

Als je het maximum aantal getoonde dagen, vastgelegd in de meta-informatie van de nieuwsbrief, eenmalig wil omzeilen, kan dit op volgende manier: http://dev.anet.ua.ac.be/services.phtml?service=anet-logboek&extra=maxdays=500

4.8. Scrolling news

Je kan de nieuwsbrief ook publiceren als een scrolling area op een statische HTML-pagina. Dit gebeurt als volgt:

Neem in je HTML pagina in het element <head> verwijzing op naar de volgende js-files

<script type="text/javascript" src="http://server/brocade/tools.js"></script>
<script type="text/javascript" src="http://server/brocade/query.js"></script>
<script type="text/javascript" src="http://server/brocade/request.js"></script>
<script type="text/javascript" src="http://server/brocade/newsletter.js"></script>

Vervang 'server' door de naam van je Brocade server.

Zet op de gewenste plaats in je HTML file de volgende code:

<!-- Scrolling area - moet id="scroller" hebben -->
<div id="scroller" style="overflow:hidden;"></div>

<!-- Vastlegging van variabelen - start scrolling - plaats onder definitie van scrolling area! -->
<script type="text/javascript">
// <![CDATA[

NEWSLETTER.scroller;

// hoogte scrolling area in px
NEWSLETTER.height = '130';

// ruimte rond de items
NEWSLETTER.margin = '10';

// scrollsnelheid = aantal milliseconden dat het duurt voor 1 item om 1 pixel op te schuiven
NEWSLETTER.speed = '25';

// aantal milliseconden dat een item stopt
NEWSLETTER.stopspeed = '2000';

// aantal items dat moet afgerold worden
NEWSLETTER.nritems = '10';

// te tonen nieuwsbrief
NEWSLETTER.newsletter = 'newsletter-id';
>!-- vervang newsletter-id door de id van de nieuwsbrief die je wil opstarten -->

// service waarnaar items moeten doorlinken
NEWSLETTER.service = 'service-id';
>!-- vervang service-id door de id van de service waarmee de nieuwsbrief wordt opgestart -->

// taal
NEWSLETTER.lg = 'N';

// start scroller
NEWSLETTER.collect();

// ]]>
</script>

4.9. Google Calendar

Het is mogelijk om items die zijn opgenomen in een Google Calendar te publiceren in een Brocade nieuwsbrief. Zo zou je met Google Calendar een agenda kunnen maken voor je bib om vervolgens de entries uit deze agenda ook te publiceren als je nieuwsbrief.

Om dit te realiseren volstaat het om in de toepassing Brocade ‣ Nieuwsbrieven ‣ Kalenders [link] de nodige parameters in te geven.

Identificatie
Kies een korte identifier (enkel kleine letters; geen cijfers; geen leestekens).
Benaming
Geef een benaming voor de nieuwsbrief. Deze benaming wordt gebruikt in het overzicht van de kalenders.
Scope
Geef (optioneel) een annotatie in die iets vertelt over het doel en de opzet van de kalender.
Benaming (N E F D U)
Geef een benaming (in de diverse talen) aan de kalender.
Geassocieerde nieuwsbrief
Geef de identifier van de nieuwsbrief waarin de kalenderitems gepubliceerd moeten worden. Opgepast: bij het overhalen van de gegevens uit Google wordt de Brocade nieuwsbrief eerst volledig gewist en vervolgens opnieuw gevuld met de overgehaalde gegevens.
Geassocieerde rubriek
Geef de identifier van de rubriek waarin de Google kalenderitems gepubliceerd moeten worden. Bij het overhalen van de Google gegevens wordt dan enkel de rubriek leeggemaakt en niet meer de gehele nieuwsbrief.
Google kalenders
Geef benaming, e-mail en wachtwoord van de Google kalender en dat in de vorm benaming:email:wachtwoord. Brocade heeft deze informatie nodig om die data vanuit Google te kunnen oogsten. Je kan meer dan één kalender opnemen. Alle items uit de diverse kalenders worden dan in dezelfde Brocade nieuwsbrief gepubliceerd.
Template voor de titel (zonder einddatum)

Geef de template voor de titel van het agenda-item, waarbij het item geen einddatum heeft. Voorbeeld:

<startTime>: <title>. Met deze placeholders worden begintijdstip en titel van
het Google agenda-item in de Brocade nieuwsbrief overgenomen.
Template voor de text (zonder einddatum)

Voorbeeld:

<where>
<content>

Met deze placeholders worden plaats van de afspraak en de beschrijving van het Google agenda-item in de Brocade nieuwsbrief overgenomen.

Template voor de titel (met einddatum)

Voorbeeld:

<startTime> - <endTime>: <title>.
Template voor de text (met einddatum).

Voorbeeld:

<where>
<content>

Het overhalen van de Google kalender gegevens naar Brocade gebeurt via de toolcat toepassing gcal. Definieer eventueel een proces in procesbeheer dat de kalendergegevens overhaalt. Voorbeelden van instructie:

  • gcal -brocade: alle in Brocade gedefinieerde Google kalenders worden overgehaald
  • gcal -brocade anet: enkel de gegevens van de in Brocade gedefinieerde anet kalender worden overgehaald.

Waarschuwing

Bij het overhalen van de gegevens uit Google wordt de Brocade nieuwsbrief eerst volledig gewist en vervolgens opnieuw gevuld met de overgehaalde gegevens. Als je dit wil vermijden is het verkieselijk om de Google kalendergegevens steeds te koppelen aan een vaste rubriek in de nieuwsbrief. In dat geval wordt bij het overhalen van de Google gegevens enkel de rubriek leeggemaakt en niet de gehele nieuwsbrief.

4.10. Takenkalender

Het is mogelijk om een Brocade takenkalender te publiceren in een Brocade nieuwsbrief. Ga naar Brocade ‣ Takenkalender ‣ Taken [link] en vul de volgende velden in.

Nieuwsbrief
Geef de identifier van de nieuwsbrief waarin de takenkalender gepubliceerd moet worden. Opgepast: bij het overhalen van de gegevens uit de takenkalender wordt de Brocade nieuwsbrief eerst volledig gewist en vervolgens opnieuw gevuld met de overgehaalde gegevens.
Rubriek
Geef de identifier van de rubriek waarin de items van de takenkalender gepubliceerd moeten worden. Bij het overhalen van de gegevens uit de takenkalender wordt dan enkel de rubriek leeggemaakt en niet meer de gehele nieuwsbrief.
Taak zelf vermelden in nieuwsitems
Vink deze optie aan indien je ook de naam van de taak in de nieuwsbrief wenst op te nemen. Het vullen van een nieuwsbrief door een taak wordt geregeld door het proces standard.tasks.