Syntax – Best Practices

Root-Strings

Verwenden Sie Platzhalter wie {firstName}, {lastName} und {company} für dynamische Inhalte.
Nutzen Sie Bedingungstags, um Inhalte gezielt anzuzeigen:
Beispiel: {#job}job: {job}{/} zeigt Inhalte nur an, wenn job definiert ist.
Standardtexte können mit invertierten Abschnitten angegeben werden: {^job} Auf der Suche nach einem Job {/}.

Bilder

Profilfotos sollten immer quadratisch sein, um die visuelle Ausrichtung sicherzustellen.
Passen Sie die Containergröße an das Bild an und verwenden Sie feste Größen wie 100:100 oder 150:150, um Konsistenz zu gewährleisten.
Vermeiden Sie nicht-quadratische Definitionen (z. B. 200:150), um Layoutprobleme zu verhindern.

Datumsformatierung

Formatieren Sie Daten mit entsprechenden Tags:
Beispiel: {start | date:“YYYY.MM.dd“} für genaue Kontrolle.
Legen Sie Ersatzwerte fest, falls keine Daten vorhanden sind: {end | date:“YYYY“:“-Kein Datum festgelegt-„}.

Benutzerdefinierte Felder

Zeigen Sie benutzerdefinierte Felder nur an, wenn Werte vorhanden sind:
Beispiel: {#customFields.date}Geburtsjahr: {customFields.date | date:“YYYY“}{/}.

Root-Arrays (z. B. Projekte, Berufserfahrung)

Wiederholen Sie Array-Elemente dynamisch mit {#projects} oder {#jobExperience}-Blöcken.
Formatieren und zeigen Sie Attribute bedingt an:
Beispiel: {start | date:“MMMM YYYY“} – {end | date:“MMMM YYYY“:’laufend‘}.
Verwenden Sie invertierte Abschnitte {^end}, um laufende Projekte zu kennzeichnen.

Zertifikate und Fähigkeiten

Zeigen Sie Zertifikate nur an, wenn welche vorhanden sind: {#certificates.length > 0}.
Kategorisieren und sortieren Sie Fähigkeiten dynamisch:
Filtern nach Bewertung: {#skills}{#rating>2}{name}{rateB}{/}{/skills}.
Vermeiden Sie die gleichzeitige Verwendung von cSkills und tSkills, außer dies ist ausdrücklich erforderlich.

Sprachen

Zeigen Sie Sprachen mit einer Bewertung über 3 als „Muttersprache“ an:
{#languages}{name}{#rating>3} (Muttersprache){/}{/languages}.

Bildung

Heben Sie die höchste Bildung separat hervor und listen Sie andere auf:
Beispiel: {#schools}{^isHighest}• {name}, {graduation}, {start | date:“YYYY“}-{end | date:“YYYY“:’nicht abgeschlossen‘}{/}{/schools}.

Allgemeine Empfehlungen

Ausrichtung von Containern: Stellen Sie sicher, dass Container ihre Inhalte vollständig anzeigen, um Abschneiden oder Überlaufen zu vermeiden.
Unsichtbare Zeichen vermeiden: Entfernen oder überschreiben Sie unsichtbare Anführungszeichen, die von Textverarbeitungsprogrammen (z. B. Word, PowerPoint) eingefügt wurden.
Fallback-Standards: Geben Sie immer Ersatzwerte an, um fehlende oder unvollständige Daten abzufangen.
Einheitliche Formatierung: Verwenden Sie vordefinierte Vorlagen und Beispiele, um die Konsistenz der Ausgaben zu wahren.

Zusätzliche Ressourcen

Dokumentation zu Tag-Typen
Bedingungen für Attribute
Filter für Listen

Durch die Einhaltung dieser Richtlinien erstellen Sie robuste und flexible Vorlagen, die vielfältige Anwendungsfälle abdecken und Fehler minimieren.

Syntax-Error Hilfe

Um eine Hilfe anzubieten, anbei die häufigsten Fehler innerhalb der Vorlagen die in der Applikation entsprechende Fehlermeldungen ausgeben.

Fehlermeldung	Bedeutung	Lösung	Typische Ursachen
The tag beginning with …	Platzhalter nicht korrekt geöffnet	Platzhalter prüfen, ggf. korrigieren	Ein Platzhalter wie {#field_name} wurde nicht korrekt geschrieben (z. B. $ {#field name} mit Leerzeichen). Ein Tag wurde geöffnet, aber nie geschlossen – oder umgekehrt.
The loop with tag „“ is unopened	Schleife nicht korrekt geöffnet	Schleifenstruktur prüfen	Ein Schleife wurde mit fehlerhaft geöffnet {skills}, das # fehlt {#skills}. Oder die Schleife wurde nicht mit dem korrekten Namen geöffnet {#skil}. -> Dadurch Folgefehler möglich
The loop with tag “ “ is unclosed	Schleife nicht korrekt geschlossen	Schleifenstruktur prüfen	Ein Schleife wurde mit {#skills} geöffnet, jedoch nicht mit {/} geschlossen
error in the template Supported file formats: .docx,.pptx	Fehlerhaftes Dateformat genutzt	Hochgeladene Datei prüfen, ob docx oder pptx
error in the template The scope parser for the tag „name==”xxxxx”“ failed to compile	Fehlerhafte Zeichen verwendet	Zeichen sollten bei Bedingungen ein einfaches Anführungungsstrich ‘xxxx‘ sein. Nicht “xxxx“

Des Weiteren sind auch KI-Assistenten eine hilfreiche Unterstützung. Bspw.: unter der Nutzung der folgenden Wordings „Es wurde folgende Syntax in einer Word Datei genutzt bei dem im Hintergrund der DocXTemplater genutzt wird. Bitte um Unterstützung bei Fehlermeldung“.