Get-ShortDescription

EulandaXtools — Funktionsreferenz

Get-ShortDescription

ÜBERSICHT

Gibt eine Kurzfassung eines längeren Textes zurück, sinnvoll abgeschnitten.

SYNTAX

Get-ShortDescription [[-Text] <string>] [[-MaxLength] <int>] [<CommonParameters>]

BESCHREIBUNG

Diese Funktion erzeugt eine kompakte Einzeilen-Zusammenfassung eines gegebenen Textes. Dabei wird der erste Zeilenumbruch beachtet und als bevorzugter Schnittpunkt verwendet. Falls der Text länger ist als der angegebene Grenzwert ('MaxLength'), wird versucht, an einem Leerzeichen zu kürzen. Wenn kein Leerzeichen gefunden wird, wird hart bei 'MaxLength' abgeschnitten.

PARAMETER

-Text

Type: string

Der Eingabetext, aus dem eine kurze Beschreibung erzeugt werden soll.

-MaxLength

Type: int
Default: 50

Die maximale Länge der Kurzbeschreibung. Standardwert: 50 Zeichen.

AUSGABEN

string

Ein gekürzter Einzeiler ohne Zeilenumbrüche.

BEISPIELE

# Gibt eine Kurzfassung zurück, die möglichst sinnvoll abgeschnitten ist (z.B.. am nächsten Leerzeichen).
Get-ShortDescription -Text "Dies ist ein sehr langer Beschreibungstext..." -MaxLength 40

HINWEISE

Diese Funktion ist besonders nützlich, um längere Texte (z.B.. HTML, Beschreibungen, Skriptkommentare) als Einzeiler in Listen, Logs oder DropDowns darzustellen. Zeilenumbrüche im Originaltext werden erkannt und bei Bedarf als Schnittpunkt verwendet.