Docbook-formatering av meddelande
- Lina Samnegård
- Per Carlén
I AddMessage.Message.text kan konsumerande system styra formateringen av ett meddelande, genom att ange formateringsinformation enligt det standardiserade layout-formatet ”DocBook” version 5.0 (Oasis standard).
Denna standard medger ett rikligt format som skapar nästan oändligt med tänkbara kombinationer. Det är därför omöjligt för inkorgen i 1177 att ge ett fulländat stöd för en dylik standard. Därför väljs ett antal delar, en delmängd av element och attribut, ur standarden för att kunna skapa väl formaterade och innehållsmässigt korrekta meddelanden. De element och attribut som stöds, samt dess möjliga kombinationer, framgår av tabellen nedan.
Notera att även 1177 Tidbok har stöd för DocBook, men att antalet element och attribut som stöds är mindre än för 1177 inkorg. Se jämförelse här: DocBook - skillnad i stödet för 1177 inkorg och 1177 tidbokning.
DocBook stöd i 1177 Inkorg
Nedanstående lista visar en komplett lista med element ur DocBook-standarden stöds av 1177 inkorg. Dessa skall alltså anges i AddMessage.Message.Text-element för att formatera meddelande till invånaren. Notera även att endast DocBook är tillåtet som formatering.
Element, attribut | Parent | Child |
article | NA | info, para, section, bibliography, variablelist |
info | article, section | title |
section | article | info, title, para, bibliography, variablelist |
para | article, section | ulink, link, emphasis |
bibliography | article, section | NA |
variablelist | article, section | title, varlistentry |
title | info, section, variablelist | emphasis |
ulink * | para | url, type |
link | para | url, type |
varlistentry | variablelist | term, listitem |
term | varlistentry | NA |
listitem | varlistentry, itemizedlist | NA |
url | ulink, link | NA |
type | ulink, link | NA |
emphasis | para, title | role (bold, italics, underline, collapsible, bgcolor, information, observe) |
role | emphasis | NA |
itemizedlist | article, section | listitem, mark (bullet, hyphen) |
listitem | itemizedlist | NA |
ulink är inte en del av DocBook 5.0 och stöds endast för bakåtkompabilitet mot befintliga integrationer. Använd link för nya implementationer.
Entity encoding
Texten i elementet ska vara i s.k. ”entity encoding” så att DocBook-elementen inte uppfattas som del av SOAP-meddelandets XML-struktur när meddelandet tas emot av konsumenten. Konsumenten behöver sedan återskapa ursprunglig XML från innehållet i elementet. Det finns många exempel på open-source-bibliotek som kan användas av producenten för att göra ”entity encoding” och av konsumenten för att återställa till XML. Ett exempel är Apache Commons Lang StringEscapeUtils: http://commons.apache.org/proper/commons-lang/javadocs/api-2.1/org/apache/commons/lang/StringEscapeUtils.html (se metoderna escapeXml respektive unescapeXml).
Här finns exempel på hur DocBook ser ut i 1177 inkorg: DocBook exempel.
För att vara säker på hur 1177 Inkorg renderar ett meddelande baserat på DocBook så bör man använda testmiljöer som Inera förvaltar: 1177 inkorg och Öppen Testmiljö.
Stödet för DocBook uppdateras löpande av förvaltningen för 1177 e-tjänster, baserat på inkomna krav och önskemål, och denna dokumentation följer dessa uppdateringar. Här finns release notes för 1177 e-tjänster: 1177 e-tjänster - release notes.