Planurkunde (Drucklayout)¶

Die Planurkunde wird mit einem QGIS-Drucklayout nach eigener Layoutvorlage erstellt. Das Plugin füllt darin Planzeichnung, Textteil und Planangaben mit den Daten eines geladenen Plans und baut die Legende aus den Layer- und Stildefinitionen auf. Es verwendet dafür ausschließlich QGIS-eigene Layoutelemente: Ein gefülltes Layout und eine Layoutvorlage funktionieren auch ohne das Plugin.

Ablauf¶

1. Plan laden.
2. Layout aus der eigenen Layoutvorlage anlegen: Projekt → Layoutverwaltung → Neu aus Vorlage (.qpt).
3. Die Layer, die die Karte zeigen soll, im Layerbaum sichtbar schalten: die des Plans und weitere, z.B. Flurstücke oder Zonierungen (siehe Planzeichnung).
4. Im Layoutdesigner XMAS-Plugin: Plandaten einfügen klicken und den Plan wählen. Ändern sich die Plandaten, füllt ein erneuter Klick das Layout neu; vorausgewählt ist der zuletzt eingefügte Plan.

Fehlt dem Layout ein Element, wird es ohne Meldung übersprungen. Eine fehlerhafte Vorlage in layout.yaml nennt die Meldungsleiste des Designers nur, wenn das Layout ihr Element hat.

Layoutvorlage vorbereiten¶

Das Plugin erkennt die Elemente des Layouts an ihrer Element-ID (Elementeigenschaften → Element-ID). In der Werkzeugleiste Elemente hinzufügen gibt es dafür die Gruppe XMAS-Plugin: Ihre Einträge legen die passenden QGIS-Elemente mit gesetzter ID an, so wie Maßstabsleiste eine Maßstabsleiste anlegt. Bestehende Elemente einer Vorlage lassen sich auch einfach mit der ID versehen. Die Einträge heißen wie die IDs, die sie vergeben; beides ist der name des Teils in der Layoutkonfiguration, für das in den Einstellungen gewählte Anwendungsschema und seine Version (xplan.map.name ersetzt den aus map):

Planzeichnung¶

Die Karte folgt dem Kartenthema XMAS: <Planname> (<Ende der ID>), das beim Einfügen angelegt bzw. aktualisiert wird, nach dem Umbenennen des Plans auch umbenannt. Es zeigt die Layer, die beim Einfügen im Layerbaum sichtbar sind, außer denen anderer Pläne: die des Plans im Stil map.style (Standard) – auch wenn in QGIS gerade Editieren aktiv ist –, alle weiteren in ihrem aktuellen Stil. Ein ausgeschalteter Layer des Plans fehlt also auch in der Karte. So kommen Flurstücke, Zonierungen oder Hintergrundkarten in die Karte: vor dem Einfügen sichtbar schalten. Was danach sichtbar wird oder nicht mehr, übernimmt die Karte erst mit einem erneuten Plandaten einfügen, auch eine mit dem Eintrag Planzeichnung neu eingefügte: Sie folgt in einem Layout mit Plandaten eines geladenen Plans gleich dessen Kartenthema und zeigt den Plan, sonst den Ausschnitt des Kartenfensters; das gilt auch für das Einfügen, das eine Legende in einem Layout ohne Plandaten auslöst. Die Karte zeigt den ganzen Geltungsbereich: im erstellungsMassstab des Plans, wenn er darin in die Karte passt, sonst im kleinsten Maßstab aus map.scales (1:500, 1:1000, 1:2000, 1:2500, 1:5000, …), in den er passt – dann mit einem Hinweis in der Meldungsleiste. Für die Planurkunde im Erstellungsmaßstab muss die Karte der Layoutvorlage also groß genug sein.

Legende¶

Die Legende wird einmal aufgebaut, wenn sie mit dem Eintrag Legende (legend.name) der Gruppe XMAS-Plugin eingefügt wird. Der Eintrag fragt wie beim Textteil nach einer Vorlage aus legend.templates (siehe unten), deren Name die Element-ID der Legende wird; ohne Auswahl bleibt legend.name die ID, und die Legende bleibt, wie QGIS sie anlegt. Hat das Layout noch keine Plandaten, fragt das Plugin zuerst nach dem Plan und fügt dessen Daten ein: Die Legende zeigt die Layer dieses Plans in seinem Kartenthema. Ebenso Legende aktualisieren: Eine Legende, die ohne geladenen Plan eingefügt wurde, bleibt, wie QGIS sie anlegt, bis Legende aktualisieren sie mit einem geladenen Plan aufbaut.

Die neue Legende listet für jeden Layer des Anwendungsschemas aus der Layerkonfiguration, in deren Reihenfolge, alle Regeln seines Stils mit Symbol, ohne die Präsentationsobjekte (Layertyp presentation); Layertitel, Gruppenregeln ohne Symbol und die Regel (ohne Stil) entfallen, ebenso die Regeln, die style_exclude_regex der Vorlage ausschließt (siehe unten). So lässt sie sich für alle Pläne einrichten: in den Legendeneigenschaften Einträge sortieren, entfernen und in Gruppen ordnen, danach Nur Elemente im Kartenausschnitt anzeigen einschalten, damit nur die in der Karte vorkommenden Einträge erscheinen. Beim Sortieren müssen die Layer im Stil Standard sein: QGIS prüft die Reihenfolge gegen den aktuellen Stil eines Layers und setzt sie im Stil Editieren zurück. Lange Texte bricht die Legende um, wenn in ihren Eigenschaften Zeilenumbruch nach gesetzt ist. Der Text eines Eintrags ist, in dieser Reihenfolge:

1. der Eintrag seines Regelnamens in legend.overrides der Layoutkonfiguration,
2. der Legendentext der Stilregel ($comment, in QGIS die Beschreibung der Regel, siehe Layerstile),
3. der Name der Stilregel.

XMAS-Plugin: Datengetriebene Gruppierung aktivieren (ein Schalter in der Werkzeugleiste, für alle Legenden mit der ID einer Legendenvorlage) zeigt die Legende unter den Gruppen ihrer Vorlage (groups, siehe unten). Gruppiert wird nach den Daten des Plans, nach jeder Eigenschaft oder dem Featuretype; die Layoutkonfiguration des Plugins gruppiert XPlanung-Legenden nach dem rechtscharakter der Objekte in Festsetzungen, Kennzeichnungen, Nachrichtliche Übernahmen und Sonstige Darstellungen. Eine neue Legende ist nicht gruppiert, eine, die noch alle Layer des Projekts zeigt (wie QGIS sie anlegt), erst nach Legende aktualisieren. Gruppiert zeigt jede Gruppe die Legende, wie sie eingerichtet ist (Reihenfolge, entfernte Einträge, eigene Untergruppen), aber nur mit den Einträgen der Stilregeln, mit denen ihre Objekte im Plan gezeichnet werden: Jedes Objekt gehört zu der ersten Gruppe, deren Filter es erfüllt. Eine Straßenverkehrsfläche, die im Plan Festsetzung und nachrichtliche Übernahme ist, steht in beiden Gruppen, eine Gruppe ohne Objekte entfällt. Selbst hinzugefügte Layer (z.B. Flurstücke) stehen einmal, nach den Gruppen. Plandaten einfügen und Legende aktualisieren lassen eine gruppierte Legende gruppiert, mit den Einträgen des Plans. Ausschalten zeigt die Legende wieder, wie sie eingerichtet ist; Rückgängig nimmt das Schalten zurück. Eingerichtet wird die Legende deshalb ungruppiert: Die Gruppen entstehen bei jedem Schalten, Einfügen und Aktualisieren neu aus ihr, Änderungen in den Gruppen gehen dabei verloren. Nur Elemente im Kartenausschnitt anzeigen wirkt zusätzlich, auch in den Gruppen.

Plandaten einfügen ändert an der Legende nur, zu welchen Layern ihre Einträge gehören: zu denen des eingefügten Plans, auch in einem Layout aus einer Layoutvorlage, deren Layer es im Projekt nicht gibt, und in einer gruppierten Legende, welche Einträge die Gruppen zeigen. Anordnung, Texte, Symbole und Einstellungen bleiben. XMAS-Plugin: Legende aktualisieren gleicht die Legenden mit der ID einer Legendenvorlage mit den Stildefinitionen und layout.yaml ab: Texte (außer von Hand geänderten, siehe unten), Symbole und die Werte der Vorlage werden neu gesetzt, neue Stilregeln und solche, die style_exclude_regex nicht mehr ausschließt, ans Ende ihres Layers angehängt, gelöschte und nun ausgeschlossene entfernt; die Anordnung bleibt, entfernte Einträge bleiben entfernt. Nötig ist das nach Änderungen an layout.yaml oder an den Stilen, auch wenn ein Plan mit geänderten Stilen neu geladen wurde: QGIS speichert die Einträge nach ihrer Position im Stil, bis dahin zeigt die Legende falsche. Einen in der Layerkonfiguration neuen Layer zeigt erst eine neu eingefügte Legende.

Weitere Layer, z.B. Flurstücke, fügt man in den Legendeneigenschaften selbst hinzu (+) und ordnet sie dort ein; ihre Texte und Symbole werden in QGIS bearbeitet. Plandaten einfügen und Legende aktualisieren lassen sie, wie sie sind. Mit Nur Elemente im Kartenausschnitt anzeigen erscheinen sie nur, wenn sie beim Einfügen der Plandaten sichtbar waren (siehe Planzeichnung). In einem Layout aus einer Layoutvorlage findet QGIS sie über Name und Datenquelle wieder, wenn das Projekt einen solchen Layer hat.

Ein Layout kann mehrere Legenden mit verschiedenen Vorlagen haben. Die Symbole und Texte kommen aus der Stildefinition (bei XPlanung xplan.yaml, der Stil Standard). Die Größen der Stile sind in Metern angegeben: In der Karte erscheint eine 0,2 m breite Linie bei 1:1000 0,2 mm breit, bei 1:5000 nur 0,04 mm. Die Legende zeichnet ihre Symbole daher wie im Maßstab scale der Vorlage, gleich in welchem Maßstab die Karte ist. Linien mit Symbolen darauf können dabei an ihren Enden ein Symbol mehr oder weniger zeigen als die Karte im selben Maßstab.

Zu einer Stilregel, deren Objekte ein Präsentationsobjekt beschriftet, zeigt die Legende dessen Planzeichen auf ihrem Symbol, z.B. WA auf der Fläche eines allgemeinen Wohngebiets. Welches Planzeichen das ist, fragt Legende aktualisieren (wie das Einfügen der Legende) die Webapp: Sie nennt nach den Regeln von XMAS-Core die stylesheetId, die ein Präsentationsobjekt für die Werte der Stilregel erhält, und seinen Text. Gezeichnet wird das Symbol der Regel der Präsentationsobjekte, die diese stylesheetId auswählt, mit diesem Text, in der Mitte des Symbolfelds und höchstens 70 % so hoch wie dieses; ein größeres wird verkleinert, damit oben und unten Rand bleibt. Nach dem Ändern der Symbolhöhe in den Legendeneigenschaften passt Legende aktualisieren die Planzeichen an. Dazu muss die Stilregel ein Planzeichen eindeutig festlegen, siehe Layerstile, und es muss eine solche Regel der Präsentationsobjekte geben. Ist die Webapp nicht erreichbar, meldet Legende aktualisieren „Planzeichen nicht verfügbar“ und zeichnet die Symbole ohne Planzeichen.

Die Texte lassen sich in den Legendeneigenschaften von Hand ändern. Solche Texte bleiben beim Einfügen der Plandaten und bei Legende aktualisieren erhalten, auch wenn ein geänderter Stil ihren Eintrag verschiebt: Legende aktualisieren ersetzt nur Texte, die noch so sind, wie das Plugin sie gesetzt hat, und geleerte. Von Hand geänderte Texte gelten nur in diesem Layout und seiner Layoutvorlage; Texte für alle Legenden gehören in legend.overrides der Layoutkonfiguration.

Textteil¶

Der Textteil besteht aus Vorlagen, die layout.yaml festlegt (siehe unten). Jede Vorlage füllt eine Feste Tabelle, deren Rahmen ihren Namen als Element-ID trägt, mit einer Zeile je ausgewähltem Textabschnitt des Plans. Der Eintrag Textteil (text.name) der Gruppe XMAS-Plugin legt eine passend eingestellte Tabelle an und fragt nach der Vorlage: Die Auswahl bietet die Vorlagen aus layout.yaml an, die noch kein Element im Layout haben; der gewählte Name wird die Element-ID. Ohne Auswahl bleibt text.name die ID. Hat das Layout Plandaten eines geladenen Plans, wird die Tabelle gleich damit gefüllt.

Wie viel Platz eine Vorlage hat, bestimmt die Layoutvorlage: Das Plugin füllt nur die Rahmen, die die Tabelle hat, und legt keine an (Rahmen hinzufügen: Vorhandene Rahmen verwenden). Jeder Rahmen ist eine Spalte; der Text läuft vom ersten Rahmen in den nächsten. Weitere Spalten entstehen mit Rahmen hinzufügen in den Tabelleneigenschaften, die Rahmen lassen sich frei anordnen. Breiter oder schmaler ziehen lässt sich ein Tabellenrahmen nicht: QGIS macht ihn so breit wie die Spalten der Tabelle. Die Breite ändert sich daher über die Spaltenbreiten in Tabelle bearbeiten. Passen sie nicht zur Zahl der Zellen von content, setzt das Plugin text.key_width je Zelle, die letzte nimmt den Rest der bisherigen Breite (ohne Spaltenbreiten text.text_width). Schrift, Ränder, Gitter und Kopfzeile kommen aus der Tabelle der Layoutvorlage; das Plugin ersetzt nur die Zeilen. Für eine mehrzeilige Kopfzeile in deren Schrift die HTML-Formatierung einschalten und je Zeile einen <div>-Block schreiben: Für Zeilenumbrüche und <br> reserviert QGIS in der Kopfzeile nur eine Zeile.

Passt nicht alles in die Rahmen, meldet der Designer „Texte passen nicht“ mit der Vorlage und der Zahl der fehlenden Zeilen: Rahmen vergrößern, weitere Rahmen hinzufügen oder die Schrift verkleinern und die Plandaten erneut einfügen. Ein Textabschnitt bleibt eine Zeile; ist er höher als jeder Rahmen, passt er nie.

Zwischenüberschriften und andere Anpassungen lassen sich nach dem Einfügen in Tabelle bearbeiten vornehmen (Zeile einfügen, Zellen verbinden, Schrift). Sie gehen beim erneuten Einfügen verloren; daher zuletzt anpassen.

Planangaben¶

Die Planangaben bestehen aus Vorlagen, die layout.yaml festlegt (siehe unten), z.B. Planname und Nummer oder die Gemeinde. Jede Vorlage füllt ein Textelement, das ihren Namen als Element-ID trägt, mit den Eigenschaften des Planobjekts in ihrem content. Der Eintrag Planangaben (plan.name) der Gruppe XMAS-Plugin legt ein Textelement an und fragt wie der Textteil nach der Vorlage; ohne Auswahl bleibt plan.name die ID. Hat das Layout Plandaten eines geladenen Plans, wird es gleich damit gefüllt; sonst zeigt es bis zum Einfügen der Plandaten als Platzhalter den content der Vorlage mit seinen Feldern, z.B. {name} und Nr. {nummer}; ohne Vorlage die ID, <Planangaben>. Passt der Plan nicht zu den Filtern einer Vorlage, z.B. featuretype_regex: "^FP_" bei einem Bebauungsplan, bleibt deren Textelement leer.

Schrift, Ausrichtung und Rahmen kommen aus dem Textelement der Layoutvorlage. Das Plugin ersetzt nur den Text, schaltet in der Schrift die HTML-Formatierung ein und bricht lange Zeilen selbst auf die Breite des Elements um. Was nicht in die Höhe passt, schneidet QGIS ab: Element vergrößern und die Plandaten erneut einfügen.

Das Layout erhält außerdem die Variablen @xmas_plan_id und @xmas_plan_appschema. Das Plugin merkt sich darin, welcher Plan eingefügt ist (vorausgewählter Plan, Legende aktualisieren).

Layoutkonfiguration (layout.yaml)¶

Die Teile der Planurkunde sind in der Layoutkonfiguration eingestellt, einer YAML-Datei, die in den Einstellungen gewählt wird; ohne Auswahl gilt die des Plugins (<Plugin-Dir>/resources/config/layout.yaml). Sie ist die Vorlage für eine eigene: Was eine eigene Datei in map, legend, text oder plan nicht angibt, nimmt das Plugin aus seiner.

map (Planzeichnung), legend (Legende), text (Textteil) und plan (Planangaben) gelten für alle Anwendungsschemas. <appschema>.map usw. ersetzen einzelne ihrer Schlüssel für ein Anwendungsschema, z.B. xplan.map für XPlanung, und <appschema>.<version>.map usw. darauf einzelne für eine Version, z.B. map unter 5.4 unter xplan für XPlanung 5.4. Andere Schlüssel als die Teile sind also Anwendungsschemas (xplan, xtrasse, xwp), unter diesen ihre Versionen (bei XPlanung 4.1, 5.4, 6.0, 6.1); einen anderen, etwa einen Tippfehler, meldet das Plugin als Fehler. Vorlagen (templates) und Gruppen (groups) heißen nach ihrem Schlüssel; eine gleichnamige ersetzt ebenso einzelne Schlüssel der Vorlage bzw. Gruppe darunter, eine neue kommt ans Ende. So gibt eine Version nur an, was bei ihr anders ist. Gilt dasselbe für mehrere Versionen, benennt &Name es bei der ersten, *Name setzt es bei den weiteren ein:

map:
  name: Planzeichnung
  scales: [500, 1000, 2000, 2500, 5000, 10000, 25000, 50000, 100000, 250000, 500000]
  style: Standard
legend:
  name: Legende
text:
  name: Textteil
  key_width: 25
  text_width: 120
plan:
  name: Planangaben

xplan:
  map:
    scales: [1000, 2000, 5000]
  legend:
    overrides:
      Allgemeines Wohngebiet: Allgemeine Wohngebiete (WA)
    templates:
      "B-Plan 1:1000":
        scale: 1000
        groups:
          Festsetzungen:
            properties:
              rechtscharakter: "1000|"
          Kennzeichnungen:
            properties:
              rechtscharakter: "7000"
          Sonstige Darstellungen:
  text:
    templates:
      Festsetzungen:
        content: "<b>{schluessel}</b>|{text}"
        sort_by: schluessel
        featuretype_regex: "^.._TextAbschnitt$"
        properties:
          rechtscharakter: "1000"
  plan:
    templates:
      Planname:
        content: "<div><b>{name}</b></div><div>Nr. {nummer}</div>"
  5.4: &kennzeichnung5000
    legend:
      templates:
        "B-Plan 1:1000":
          groups:
            Kennzeichnungen:
              properties:
                rechtscharakter: "5000"
  4.1: *kennzeichnung5000

Die Einrückung gibt an, was wozu gehört: je Ebene zwei Leerzeichen, keine Tabulatoren. Ein Schlüssel gilt so, wie er geschrieben ist, auch 5.4 oder 1.10, und kommt je Ebene einmal vor: Einen doppelten meldet das Plugin mit seiner Zeile als Fehler. Werte mit Zeichen wie {, [, |, *, &, : oder #, also HTML und Regex-Ausdrücke, stehen in Anführungszeichen. In doppelten Anführungszeichen leitet \ eine Escape-Sequenz ein; ein Regex-Ausdruck mit \ steht daher in einfachen ('\d+') oder verdoppelt ihn ("\\d+").

Die Namen der Einträge im Layoutdesigner folgen der Datei, wie sie beim Start des Plugins (startet es mit QGIS: beim ersten Layoutdesigner) oder beim letzten OK in den Einstellungen war.

legend.overrides ersetzt die Legendentexte der Stilregeln: Regelname: Text, siehe Legende. Der Regelname ist der name der Regel im Stil, in QGIS ihre Bezeichnung (Layereigenschaften → Symbolisierung). Ein Eintrag gilt für alle Regeln dieses Namens; eine Regel ohne Namen behält ihren Text. Geänderte Texte übernimmt Legende aktualisieren, außer in Einträgen, deren Text von Hand geändert ist.

legend.templates sind die Vorlagen der Legende, je unter der Element-ID ihrer Legende im Layout; alle Schlüssel sind optional, eine Vorlage ohne ist nur ihr Name mit Doppelpunkt:

text.templates sind die Vorlagen des Textteils, je unter der Element-ID ihres Tabellenrahmens, plan.templates die der Planangaben, je unter der ID ihres Textelements. Vorlagen unter legend, text bzw. plan gelten für alle Anwendungsschemas; die eines Anwendungsschemas und einer Version kommen hinzu oder ändern gleichnamige, siehe oben. Eine Vorlage des Textteils nimmt die Objekte der Layer des Plans vom Layertyp text, eine der Planangaben das Planobjekt:

content ist HTML; im Textteil trennt | die Zellen einer Zeile. {Eigenschaft} wird wie bei Python str.format durch den Wert ersetzt, Zahlen auch formatiert ({GFZ:.0f}), {refText[referenzName]} durch das Feld eines Datentyps. Codes von Aufzählungen erscheinen mit ihrem lesbaren Namen (z.B. planArt Qualifizierter BPlan), Datumsangaben als TT.MM.JJJJ, Listen durch Komma getrennt; eine fehlende Eigenschaft bleibt leer. Die lesbaren Namen liefert die Webapp; ist sie nicht erreichbar, bleiben die Codes stehen. Codelisten-Werte erscheinen unverändert. Die Werte werden als Text eingesetzt (< bleibt <). Von HTML zeichnet QGIS in Tabellen und Textelementen z.B. <b>, <i>, <span style="…"> und Blöcke <div>…</div>. Mehrere Zeilen sind Blöcke, je einer pro Zeile, z.B. <div><b>{schluessel}</b></div><div>{text}</div>. <br> zeichnet QGIS in Tabellen fehlerhaft: Formatierter Text danach springt in eine eigene Zeile, aus <b>1</b><br>a <i>b</i> wird „1a“ und „b“. Zeilenumbrüche in den Werten (Absätze eines Textabschnitts) bleiben erhalten. Lange Zeilen bricht das Plugin selbst auf die Breite der Spalte bzw. des Textelements um.

Fehler in der Datei oder in einer Vorlage (fehlende Tabelle oder fehlendes Textelement, fehlerhafter content oder Regex) meldet der Designer; die übrigen Teile werden trotzdem gefüllt.