Brontekst bekijken van Catalogus documentsjabloon

__TOC__
= Algemeen =
=== Interne documentgenerator LibreOffice ===
Zaaksysteem.nl heeft een interne documentgenerator van [https://www.libreoffice.org/ LibreOffice]. Dit maakt het mogelijk om geautomatiseerd documenten aan te maken op basis van een sjabloon, zoals bijvoorbeeld een ontvangstbevestiging of beschikking. Documentsjablonen worden centraal in de [[Catalogus|Catalogus]] beheerd en worden aan [[Catalogus_zaaktype|Zaaktypen]] toegevoegd, zodat deze in zaken gebruikt kunnen worden.

Nieuwe documentsjablonen worden gemaakt door documenten op te maken en deze op te slaan als een ODT-bestand. Je kunt hiervoor [https://www.libreoffice.org/ LibreOffice] gebruiken (indien er geen mogelijkheid is tot het installeren van LibreOffice kan er ook gebruik gemaakt worden van de [http://portableapps.com/apps/office/libreoffice_portable portable LibreOffice app]), maar ook Microsoft Office 2010 kan documenten opslaan in dit formaat.

Een documentsjabloon werkt met ‘magicstrings’. Dit zijn de variabele die verwijzen naar de waarden van [[Catalogus_kenmerk|Kenmerken]] binnen een zaak, die het zaaksysteem kan invullen tijdens het genereren van een document.

=== Externe documentgenerator Xential ===
Zaaksysteem.nl heeft ook een koppeling met de documentgenerator [https://www.xential.nl/ Xential]. Zie voor meer informatie het [[Koppelprofiel_Xential|Koppelprofiel Xential]].

=== Externe documentgenerator StUF-DCR ===
Zaaksysteem.nl heeft ook een koppeling met de documentgenerator van een StUF-DCR aanbieder, zoals [http://smartdocuments.eu/ SmartDocuments]. Zie voor meer informatie het [[Koppelprofiel_StuF_DCR|Koppelprofiel StUF DCR]].

= Iteratie =
<i>De oude methode (t/m versie 3.21) is hier in te zien: [[Documentsjablonen_iteratie|Documentsjablonen - Iteratie]].</i>
<br>
<br>
Iteratie zorgt ervoor dat informatie voor de magicstrings niet uit de zaak zelf wordt opgehaald, maar uit alle [[Zaakdossier_relaties|Gerelateerde zaken]]. Dit kan vervolgens op drie manieren worden weergegeven:<br>
<ul>
<li>Inline itereren: Op één regel, gescheiden door <komma><spatie></li>
<li>Tekstblok newline itereren: Een tekstblok dat geïtereerd wordt voor elke gerelateerde zaak, gescheiden door <enter></li>
<li>Tabel itereren: Eén tabelrij itereren om één tabel te vormen met informatie uit de gerelateerde zaken</li>
</ul>

Let op: De iteratie moet direct naar de gewenste waarde verwijzen. Iteratie kan geen magicstrings in magicstrings of iteratie in iteratie verwerken.

=== Inline ===
{| class="wikitable"
! scope="col" width="50pt"|
!Input
!Output
|- 
!Gerelateerde zaken
|<pre>De volgende zaken zijn verwerkt: [[iterate:case.related_cases:zaaknummer]].</pre>
|<pre>De volgende zaken zijn verwerkt: 2462, 2463, 2465, 2467.</pre>
|- 
!Deelzaken
|<pre>De volgende zaken zijn verwerkt: [[iterate:case.child_cases:zaaknummer]].</pre>
|<pre>De volgende zaken zijn verwerkt: 2462, 2463, 2465, 2467.</pre>
|}

Let op: Er kan slechts één actie per magicstring uitgevoerd worden. Het is daarom niet mogelijk om inline te itereren én kenmerkformatting toe te passen.

=== Newline ===
{| width=100%
|- style="vertical-align:top;"
|In de sjablonen kan een tabellenrij herhaald worden voor elk van de gerelateerde of deelzaken die de zaak heeft.
<ol>
  <li>Zet de cursor op de juiste plek of selecteer het blok tekst en selecteer in het menu Insert - Section...</li>
  <li>Zet de cursor in de sectie en selecteer in het menu Insert - Script...</li>
  <li>Verander de waarde van 'Script type' in 'zttscript'</li>
  <li>Selecteer de 'Text' optie en vul in:
    <ul>
      <li>Voor gerelateerde zaken: <pre>iterate case.related_cases</pre></li>
      <li>Voor deelzaken: <pre>iterate case.child_cases</pre></li>
    </ul>
  </li>
</ol>
Let op: De iteraties worden gescheiden door een return (enter).
|[[bestand:sjablonen iteratie script dialog.png|thumb|Dialoog voor scripts]]
|}

=== Tabel ===
{| width=100%
|- style="vertical-align:top;"
|In de sjablonen kan een tekstblok herhaald worden voor elk van de gerelateerde of deelzaken die de zaak heeft.
<ol>
  <li>Maak een tabel die één rij hoog is</li>
  <li>Zet de cursor op een willekeurige plek in de tabel en selecteer in het menu Insert - Script...
    <ul>
      <li>Let op: Voor LibreOffice 5+ moet de optie 'Script' toegevoegd worden via View - Toolbars - Customize. De optie wordt toegevoegd op de geselecteerde locatie met 'Add'. De optie staat onder de categorie 'Insert'.</li>
    </ul>
  </li>
  <li>Verander de waarde van 'Script type' in 'zttscript'</li>
  <li>
    Selecteer de 'Text' optie en vul in:
    <ul>
      <li>Voor gerelateerde zaken: <pre>iterate case.related_cases</pre></li>
      <li>Voor deelzaken: <pre>iterate case.child_cases</pre></li>
    </ul>
  </li>
</ol>

Tabellen hebben over het algemeen een titelrij, maar omdat een itererende tabel uit maar één rij mag bestaan kan deze niet in dezelfde tabel opgenomen worden. De oplossing is eenvoudig: Maak twee tabellen van elk één rij; één voor de titels en één voor de iteratie. Plak deze vervolgens tegen elkaar door de enters ertussen uit te verwijderen.

=== Iteraties filteren ===
In sommige gevallen is het niet wenselijk dat alle zaken worden meegenomen bij de iteratie. Daarom kan er aan een iteratie een voorwaarde meegegeven worden, zodat enkel zaken die aan die voorwaarde voldoen geïtereerd worden.
<pre>
iterate case.related_cases { case.zaaktype == "Vergadering" }
iterate case.related_cases { mor_categorie == "Afval" }
</pre>

Zie voor de mogelijke vergelijkingen: [[Rekenen_en_Vergelijkingen|Rekenen en Vergelijkingen]]


|[[bestand:sjablonen iteratie script dialog.png|thumb|Dialoog voor scripts]]
|}

= Variabele teksten =
{| width=100%
|- style="vertical-align:top;"
|
<p>
  <i>
    De oude methode (t/m versie 3.21) is hier in te zien:
    [[Documentsjablonen_variabele_teksten|Documentsjablonen Variabele teksten]].
  </i>
</p>

<p>
  In de sjablonen kan een gedeelte van het sjabloon afhankelijk van een waarde in de zaak getoond of verborgen worden.

  <ol>
    <li>Zet de cursor op de juiste plek of selecteer het blok tekst en selecteer in het menu Insert - Section... of Insert - Frame...</li>
    <li>Zet de cursor in de sectie/frame en selecteer in het menu Insert - Script...</li>
      <ul>
        <li>Let op: Voor LibreOffice 5+ moet de optie 'Script' toegevoegd worden via View - Toolbars - Customize. De optie wordt toegevoegd op de geselecteerde locatie met 'Add'. De optie staat onder de categorie 'Insert'.</li>
      </ul>
    <li>Verander de waarde van 'Script type' in 'zttscript'</li>
    <li>Selecteer de 'Text' optie en vul in: <pre>show_when { voorbeeld_magicstring == "voorbeeld waarde" }</pre></li>
  </ol>
</p>

=== Mogelijke vergelijkingen ===
Zie voor de mogelijke vergelijkingen: [[Rekenen_en_Vergelijkingen_Samenvatting|Rekenen en Vergelijkingen]] of [[Rekenen_en_Vergelijkingen|Rekenen en vergelijkingen uitgebreid]]

=== Voorbeeld ===
{| class="wikitable"
|-
!Sjabloon
|
Beste meneer [&#8203;[aanvrager_naam]&#8203;],<br>
<br>
Sectie 1 met: Uw aanvraag is [&#8203;[beoordeling_compleet]&#8203;]. U kunt uw aanvraag volgen op uw persoonlijke internetpagina.<br>
Sectie 2 met: Uw aanvraag is [&#8203;[beoordeling_compleet]&#8203;]. U kunt de ontbrekende documenten toevoegen via uw persoonlijke internetpagina.
|-
!Script sectie 1
|
<pre>show_when { beoordeling_compleet == "ontvankelijk" }</pre>
|-
!Script sectie 2
|
<pre>show_when { beoordeling_compleet == "niet ontvankelijk" }</pre>
|-
!Output
|
<b>Bij ontvankelijk:</b><br>
Beste meneer Piet Friet,<br>
<br>
Uw aanvraag is ontvankelijk. U kunt uw aanvraag volgen op uw persoonlijke internetpagina.<br>
<br>
<b>Bij niet ontvankelijk:</b><br>
Beste meneer Piet Friet,<br>
<br>
Uw aanvraag is niet ontvankelijk. U kunt de ontbrekende documenten toevoegen via uw persoonlijke internetpagina.
|}
|[[bestand:Sjablonen variabel script dialog.png|thumb|Dialoog voor scripts]]
|}

= Variabele newline iteratie =
Newline iteratie en variabele teksten maken beide gebruik van secties met daarin een zttscript. Het is daarom mogelijk om deze te combineren met het volgende script:
<pre>
show_when { voorbeeld_magicstring == "voorbeeld_waarde" }
iterate case.child_cases
</pre>

Let op: De volgorde is hier van belang. In het bovenstaande voorbeeld wordt eerst
gekeken of het iteratie blok opzich getoond moet worden, en wordt vervolgens pas
de iteratie uitgevoerd. Zou de volgorde van de instructies omgedraaid zijn wordt
eerst een volledige iteratie gedaan, en wordt het originele tekstblok verborgen.
Effectief houd dit in dat er altijd geïtereerd wordt.

Let op: Dit is niet hetzelfde als [[Catalogus_documentsjabloon#Iteraties_filteren|Iteraties filteren]]. De magicstrings in de 'show_when'-voorwaarde verwijzen naar de zaak zelf en niet naar de gerelateerde en/of deelzaken.

= Tips =
===== Paginaovergang =====
{| width="100%"
|- style="vertical-align:top;"
|Door variabele tekstblokken te gebruiken is het vrijwel onmogelijk om een paginaovergang goed in te richten. De paginaovergang zal vaak erg lelijk zijn: titel en tekst gescheiden, tabellen in tweeën geknipt, etc. De oplossing hiervoor is om deze teksten in frames te zetten. Deze frames kunnen niet over meerdere pagina's heen vallen en een paragraaf zal daarom netjes als één geheel naar de volgende pagina springen.

Het beste resultaat kan bereikt worden door deze frames:
<ul>
<li>paginabreed te maken (17cm)</li>
<li>aan de paragraaf te verankeren</li>
<li>geen 'wrap' toe te laten</li>
<li>geen spacing te geven</li>
<li>geen rand te geven</li>
</ul>
|[[Bestand:variabele documentsjablonen frame.png|thumb|De titel en tekst blijven netjes bij elkaar]]
|}