Syntax, specialtecken och återgivning
Ämnen |
---|
Kodning och giltiga tecken |
Kodningen måste vara UTF-8. I den här guiden anges tecknen med sina Unicode-kodpunkter vid behov. Giltiga tecken är U+0020 till U+007E, U+00A0 till U+FFEF liksom U+000A (radmatning), U+0009 (tabb) och U+000D (vagnretur). |
Definitioner |
Observera att det vissa versioner av BankID-klienten genereras ett fel om ett blanksteg avslutar en fetformaterad rad. I regel bör du därför undvika att använda avslutande blanksteg.
|
Åsidosättning |
Vissa tecken kan åsidosättas genom att infoga '\' före. Sådana tecken är #, +, |, *, - och \.
|
Inline-formatering |
All text stöder inline-formatering, oavsett om den finns i ett stycke, en tabellcell eller någon annanstans. All formatering som inte är integrerad (inline) i texten identifieras av en inledande token på den relevanta raden. Om resten av raden inte följer syntaxen för den aktuella formateringstypen är dokumentet ogiltigt. |
Rubriker |
Inledande token: En till tre '#'-tecken. En rubrik definieras som en rad som börjar med ett till tre '#'-tecken, ett mellanslag följt av rubriktexten. Om rubriktexten saknas eller det bara finns blanksteg, är dokumentet ogiltigt. Rubriknivån är lika med antalet inledande '#'-tecken. |
Tematisk brytning |
Inledande token: '---' Tematisk brytning definieras som en rad som är lika med '---', eventuellt följt av blanksteg. |
Tabeller |
En tabell är ett tabellhuvud (en rad), en avgränsarrad och noll eller fler tabelldatarader. En tabell som har fler än fem kolumner gör dokumentet ogiltigt. Alla rader i en tabell måste ha samma antal celler. Tabellrad
Varje tabellrad är en rad som börjar och slutar med ett '|' (lodstreck). Mellan dem är tabellcellerna åtskilda av lodstreck. Observera att det i vissa versioner av BankID-klienten genereras ett fel om blanksteg placeras intill lodtecken. Inkludera inte inledande eller avslutande blanksteg i celler. Att utelämna blanksteg i underskriftstexten här är dock inget problem eftersom inledande och avslutande blanksteg ändå läggs till automatiskt i utresultatet. Cellinnehållet är text för tabellhuvudet och tabelldataraderna. Tabeller skalas till telefonens bredd. Detta innebär att textstorleken minskar för bredare tabeller. Undvik att använda för mycket text i tabellceller. För texten i tabellhuvudet används fet stil som standard. Observera att det i vissa versioner av BankID-klienten genereras ett fel om en cell innehåller både vanlig text och fet text. En cell kan innehålla text som är antingen vanlig eller fet, men inte båda varianterna. Avgränsningsrad Ett kolon till vänster definierar kolumnen som vänsterjusterad, ett kolon till höger definierar den som högerjusterad, och kolon på båda sidorna definierar den som centrerad. Kolumner är vänsterjusterade som standard. Ingen annan synlig text är tillåten i avgränsarraden, men blanksteg är tillåtet mellan '|í och ':í samt mellan '|í och '-í. |
Listor |
En lista består av ett eller flera listobjekt. Ett listobjekt definieras av en rad som börjar med den inledande token följt av ett mellanslag följt av listobjekttexten. I sorterade listor är alla siffror signifikanta, i motsats till flera andra vanliga kodmärkningsvarianter. Det här innebär att du kan ha listnummer som är dubbletter, du kan ha luckor i numrering och så vidare. Inledande redundanta nollor i numrering är inte tillåtet. Om texten i ett listobjekt saknas eller bara innehåller blanksteg är dokumentet ogiltigt. |
Tomma rader |
Tomma rader är giltiga, men återges inte. Tomma rader är syntaktiskt signifikanta som avgränsare mellan två tabeller eller två listor av samma typ. |
Stycken |
En rad som inte är en rubrik, en tematisk brytning, en tabellrad, ett listobjekt eller en tom rad är ett stycke. Allt innehåll i ett stycke behandlas som text. Ett stycke avslutas med radslut eller dokumentslut. |
Fet stil |
Början och slutet av ett avsnitt med fet stil definieras av '*'. Det inledande '*'-tecknet får inte följas av blanksteg. Det avslutande '*'-tecknet får inte föregås av blanksteg. Till exempel tillåts inte * fet katt*, *fet katt * eller * fet katt *. Om ett avsnitt med fet stil inte avslutas korrekt är dokumentet ogiltigt. |
Ämnen
Kodningen måste vara UTF-8.
I den här guiden anges tecknen med sina Unicode-kodpunkter vid behov.
Giltiga tecken är U+0020 till U+007E, U+00A0 till U+FFEF liksom U+000A (radmatning), U+0009 (tabb) och U+000D (vagnretur).
Blankstegstecken: mellanslag (U+0020) eller tabb (U+0009).
Blanksteg: En sekvens av ett eller flera blankstegstecken. En sekvens av blankstegstecken återges som ett enda blanksteg. Inledande och avslutande blanksteg trunkeras.
Observera att det vissa versioner av BankID-klienten genereras ett fel om ett blanksteg avslutar en fetformaterad rad. I regel bör du därför undvika att använda avslutande blanksteg.
Mellanslag: Ett U+0020-tecken.
Radslut: Ny rad (U+000A), vagnretur (U+000D) eller vagnretur följt av ny rad.
Rad: En sekvens med noll eller fler tecken, som inte är ny rad (U+000A) eller vagnretur (U+000D), följt av radslut eller dokumentslut.
Vissa tecken kan åsidosättas genom att infoga '\' före. Sådana tecken är #, +, |, *, - och \.
Att infoga '\' före andra tecken är ogiltigt.
Åsidosatta tecken återges som text. Åsidosättningstecknet '\' återges inte.
Tecken som kan åsidosättas behandlas som text där de saknar syntaktisk betydelse:
'#', '-' och '+' har syntaktisk betydelse endast när de är det första tecknet på en rad.
'|' har syntaktisk betydelse endast när det är det första tecknet på en rad eller när det förekommer på en rad där det första tecknet är '|'.
'*' har syntaktisk betydelse i textflöden.
'\' har alltid syntaktisk betydelse.
All text stöder inline-formatering, oavsett om den finns i ett stycke, en tabellcell eller någon annanstans.
All formatering som inte är integrerad (inline) i texten identifieras av en inledande token på den relevanta raden. Om resten av raden inte följer syntaxen för den aktuella formateringstypen är dokumentet ogiltigt.
Inledande token: En till tre '#'-tecken.
En rubrik definieras som en rad som börjar med ett till tre '#'-tecken, ett mellanslag följt av rubriktexten.
Om rubriktexten saknas eller det bara finns blanksteg, är dokumentet ogiltigt.
Rubriknivån är lika med antalet inledande '#'-tecken.
Inledande token: '---'
Tematisk brytning definieras som en rad som är lika med '---', eventuellt följt av blanksteg.
En tabell är ett tabellhuvud (en rad), en avgränsarrad och noll eller fler tabelldatarader. En tabell som har fler än fem kolumner gör dokumentet ogiltigt. Alla rader i en tabell måste ha samma antal celler.
Tabellrad
Inledande token: '|'
Varje tabellrad är en rad som börjar och slutar med ett '|' (lodstreck). Mellan dem är tabellcellerna åtskilda av lodstreck. Observera att det i vissa versioner av BankID-klienten genereras ett fel om blanksteg placeras intill lodtecken. Inkludera inte inledande eller avslutande blanksteg i celler. Att utelämna blanksteg i underskriftstexten här är dock inget problem eftersom inledande och avslutande blanksteg ändå läggs till automatiskt i utresultatet.
Cellinnehållet är text för tabellhuvudet och tabelldataraderna. Tabeller skalas till telefonens bredd. Detta innebär att textstorleken minskar för bredare tabeller. Undvik att använda för mycket text i tabellceller.
För texten i tabellhuvudet används fet stil som standard. Observera att det i vissa versioner av BankID-klienten genereras ett fel om en cell innehåller både vanlig text och fet text. En cell kan innehålla text som är antingen vanlig eller fet, men inte båda varianterna.
Avgränsningsrad
Alla celler i avgränsningsraden måste innehålla ett eller flera efter varandra följande '-'-tecken. Kolon ':' kan användas på ena eller båda sidorna av '- '-sekvensen.
Ett kolon till vänster definierar kolumnen som vänsterjusterad, ett kolon till höger definierar den som högerjusterad, och kolon på båda sidorna definierar den som centrerad. Kolumner är vänsterjusterade som standard.
Ingen annan synlig text är tillåten i avgränsarraden, men blanksteg är tillåtet mellan '|í och ':í samt mellan '|í och '-í.
Inledande token för en osorterad lista: '+'
Inledande token för en sorterad lista: A '+' följt av en sekvens av en eller två siffror, utvärderas till noll eller ett positivt heltal.
En lista består av ett eller flera listobjekt. Ett listobjekt definieras av en rad som börjar med den inledande token följt av ett mellanslag följt av listobjekttexten.
I sorterade listor är alla siffror signifikanta, i motsats till flera andra vanliga kodmärkningsvarianter. Det här innebär att du kan ha listnummer som är dubbletter, du kan ha luckor i numrering och så vidare.
Inledande redundanta nollor i numrering är inte tillåtet. Om texten i ett listobjekt saknas eller bara innehåller blanksteg är dokumentet ogiltigt.
Tomma rader är giltiga, men återges inte. Tomma rader är syntaktiskt signifikanta som avgränsare mellan två tabeller eller två listor av samma typ.
En rad som inte är en rubrik, en tematisk brytning, en tabellrad, ett listobjekt eller en tom rad är ett stycke. Allt innehåll i ett stycke behandlas som text. Ett stycke avslutas med radslut eller dokumentslut.
Början och slutet av ett avsnitt med fet stil definieras av '*'.
Det inledande '*'-tecknet får inte följas av blanksteg. Det avslutande '*'-tecknet får inte föregås av blanksteg. Till exempel tillåts inte * fet katt*, *fet katt * eller * fet katt *.
Om ett avsnitt med fet stil inte avslutas korrekt är dokumentet ogiltigt.