opinion-documenter

html pdf creater

Usage no npm install needed!

<script type="module">
  import opinionDocumenter from 'https://cdn.skypack.dev/opinion-documenter';
</script>

README

opinion-documenter

Modul für die Generierung eines PDF Dokuments eines Gutachtens. Das Gutachten mit den entsprechenden Inhalten wird als Parameter an die Funktion "pdfCreate" übergeben.

Used Packages

Getting started

npm install opinion-documenter --save

Example usage

const opinionDocumenter = require( 'opinion-documenter' );
let opinion = {};
let details = [];
let detailsTodolist = [];
let images = [];
let pdfPath = '';
const filename = await opinionDocumenter.pdfCreate( opinion , details , detailsTodolist , images , pdfPath );

Good to know

Rückgabewert

String "Pfad + Dateiname" des generierten PDF-Dokuments, wenn Erstellung erfolgreich durchgeführt wurde. Ansonsten ''.

Parameter der Funktion pdfCreate

Die ersten 4 Parameter der Funktion pdfCreate sind verpflichtend und beinhalten:

  1. opinion: Das Gutachten "Objekt".
  2. details: Das Array der zum Gutachten gehörenden Gutachten-Details.
  3. detailsTodolist: Das Array der Gutachten-Details, das alle im Gutachten enthaltenen (aktiven) Fragen mit Handlungsbedarf enthält.
  4. images: Das Array der Bilder, die im Gutachten enthalten sind.
  5. pdfPath: Pfad, in den das zu erstellende PDF Dokument geschrieben werden soll. Als Dateiname wird automatisch "{opinion._id}.pdf" gesetzt.

Paramteter 6-9 sind optional und beinhalten:

  1. hasAbbreviationsPage: default: true - Bool, der angibt, ob im Dokument das fest hinterlegte Abkürzungsvereichnis enthalten sein soll.
  2. hasToC: default: true - Bool, der angibt, ob Inhaltsverzeichnis generiert werden soll.
  3. print: default: false - Bool, der angibt, ob PDF für Ausdruck (=true) gedacht ist oder nicht (=false). Wenn print == false (also rein für digitale Betrachtung), dann werden im Inhaltsverzeichnis Links eingefügt. Bei print == true keine Links. Nur relevant, wenn hasToC == true.
  4. ToCPageNos: default: true - Bool, der angibt, ob im Inhaltsverzeichnis Seitenzahlen angegeben werden sollen. Nur relevant, wenn hasToC == true.

Variablen

Interne Variablen

Folgende internen Variablen werden verwendet bzw. können im Dokument verwendet werden:

  • ${Firma} - aus opinion
  • ${Druckdatum} - Datum zum Zeitpunkt des Funktionsaufrufs
  • ${Gutachtennummer} - aus opinion
  • ${GutachterName1} - aus opinion
  • ${GutachterName2} - aus opinion
  • ${GutachterName1Full} - zusammengesetzt aus opinion und Profildaten (ab Version 1.0.33)
  • ${GutachterName2Full} - zusammengesetzt aus opinion und Profildaten (ab Version 1.0.33)

Zusätzliche Variablen

Folgende Variablen können vom Anwender genutzt werden zum Überschreiben der default-Werte:

Für das "Deckblatt" (1. Seite) des Dokuments
  • {{!Titel}} - default: 'Gutachtliche Stellungnahme'
  • {{!Untertitel}} - default: 'Sicherheit in der Elektrotechnik'
  • {{!ZusatztextZeile1}} - default: 'Schwerpunkt ist der Aufbau einer rechtssicheren'
  • {{!ZusatztextZeile2}} - default: 'Organisationsstruktur im Bereich der Elektrotechnik'
  • {{!StandortLangtext}} - default: ''. Empfehlung, falls benötigt: 'am Standort xyz'
Für die 2. Seite des Dokuments für den Namen des Ansprechpartners des Auftraggebers
  • {{!AuftraggeberName}} - default: ''