Simple RML-Anweisungen
Mit RML werden deine Dokumenten-Vorlagen in Noahworks formatiert. Lerne Anweisungen kennen, um deine Dokumentenvorlagen anzupassen.
Inhalte des Artikels: Springe durch Klick auf das Thema direkt zum jeweiligen Absatz.
Was ist RML?
RML ist die Programmiersprache, die verwendet wird, um Dokumenten-Vorlagen zu formatieren und zu generieren. Zum Beispiel um Seitenränder, Überschriften und Texte, Kopf- oder Fußzeile in Rechnungen, Angeboten, Bestätigungen usw. zu formatieren.
Zudem ist RML maschinenlesbar und auf XML aufgebaut, was für Rechnungsdokumente aufgrund der seit einigen Jahren geltenden E-Rechnungs-Verpflichtung wichtig ist.
Einfach gesagt
RML ist wie ein Bauplan für ein Dokument. Die RML-Vorlage sagt der Software, wie das Dokument aufgebaut sein soll. Die Software setzt anschließend die richtigen Daten ein und erstellt daraus das fertige Dokument.
Hinweis zur Bearbeitung
Kleinere Änderungen kannst du selbst vornehmen. Dazu gehören zum Beispiel neue Adressen, geänderte Telefonnummern, angepasste Kontaktangaben oder neue Links. Für größere Anpassungen wie ein anderes Layout wende dich bitte an uns.
Wie unterscheidet sich RML von HTML?
Die Anweisungen für die Platzhalter sehen oft gleich aus, weil sie nicht unbedingt nur Teil von HTML oder RML selbst sind. Sie sehen sich auf den ersten Blick ähnlich, weil beide mit Tags arbeiten. RML hat eine eigene Dokumentlogik, bei der Textblöcke, Listen, Tabellen und Seitenlayout anders aufgebaut werden.
Der leichteste sichtbare Unterschied sind allgemeine Anweisung für Textabschnitte:
- <p> von HTML
- <para> von RML
Absätze mit <para> einfügen
Nutze <para>, wenn ein Text als eigener Absatz erscheinen soll. Absätze helfen, Vorlagen übersichtlich zu gliedern. Verwende sie für neue Gedanken, Hinweise oder Abschnitte.
In dieser Anweisung kann auch die Schriftart für den Absatz hinterlegt werden. Ob das möglich ist, hängt allerdings davon ab, ob und welche Schriftarten für dich hinterlegt sind. Grundsätzlich hinterlegen wir das für dich und du musst keine Anpassungen vornehmen.
Setze <para> vor und </para> nach einem Absatz, um den Absatz abzuschließen.
Überschriften einfügen
Verwende Überschriften, wenn eine Vorlage mehrere Bereiche enthält. <h2> eignet sich für größere Abschnitte, <h3> für kleinere Unterabschnitte innerhalb eines <h2>-Abschnitts.
Zeilenumbrüche mit <br/>
Verwende <br/>, wenn du innerhalb eines Absatzes eine neue Zeile beginnen möchtest. Ein Zeilenumbruch eignet sich besonders für Grußformeln, Adressen oder Kontaktdaten.
Verwende <br/> sparsam. Für längere Textabschnitte sind Absätze mit <para> meist besser geeignet.
Hervorhebungen mit <b> einfügen
Nutze <b>, wenn ein Wort oder Satzteil hervorgehoben werden soll. Es eignet sich für wichtige Begriffe, Veranstaltungstitel, Fristen oder Hinweise. Aber vermeide zu viele Hervorhebungen.
Setze vor den zu hervorhebenden Teil <b> und danach </b> zum Beenden der Hervorhebung.
Verlinkungen mit <a href=""> einfügen
In RML können Verlinkungen ähnlich wie in HTML eingefügt werden. Dafür wird ebenfalls der Tag <a href=""></a> verwendet.
Ein RML-Tag besteht aus zwei Teilen:
- dem Linkziel in den Anführungszeichen von
href="" - dem sichtbaren Linktext zwischen
<a>und<a/>
Du kannst die Adresse direkt als Link darstellen oder hinter einem Wort ablegen.
Verlinkte Adresse darstellen
Manchmal soll die vollständige Adresse im Dokument sichtbar sein. Dann kann die URL auch als Linktext verwendet werden.
So funktioniert es:
<para> Weitere Informationen findest du unter
a href="https://example.com">https://example.com</a>.
</para>
Link hinter einem Wort verstecken
Ein Link kann direkt in einen normalen Satz oder einem Wort eingebaut werden. Das Ergebnis ist ein normaler Satz, bei dem nur der Text verlinkt ist.
So funktioniert es:
<para> Weitere Informationen findest du
a href="https://example.com">auf dieser Seite</a>.
</para>
Listen mit <ul> oder <ol> einfügen
Nutze Listen, wenn du mehrere Punkte untereinander darstellen möchtest. Du kannst hier zwischen einer Liste mit Aufzählungspunkten (grün markiert) oder einer nummerierten Liste (rot markiert) wählen.
Liste mit Aufzählung
Dafür verwendest du den RML-Tag <ul> und <ul/>.
Nummerierte Liste
Dafür verwendest du den RML-Tag <ol> und <ol/>.
Häufige Fehler in RML
- Eine Anweisung wird nicht richtig geschlossen, egal welche Art von Anweisung (Text, Hervorhebung, Liste usw.)
- Wenn ein Text ohne <para> eingefügt wird, erkennt RML den Textblock nicht korrekt.
- Eine Link-Anweisung enthält keine Linkadresse.
Eine Anweisung wird nicht geschlossen:
- Egal ob der allgemeine RML-Hinweis oder eine andere Anweisung. Am Ende muss immer ein Anweisung wie
</para> oder oder<li/>stehen.
Ein Link enthält keine Adresse:
- Zwischen den Anführungszeichen wurde kein Link hinterlegt.
