/ 
Quiq-1.135
River stage zero No dependents
/ Quiq::LaTeX::Code

NAME

Quiq::LaTeX::Code - Generator für LaTeX Code

BASE CLASS

Quiq::TeX::Code

DESCRIPTION

Ein Objekt der Klasse repräsentiert einen LaTeX Code-Generator. Mit den Methoden der Klasse kann aus einem Perl-Programm heraus LaTeX-Code erzeugt werden. Die Klasse stützt sich ab auf ihre Basisklasse Quiq::TeX::Code. Weitere Methoden siehe dort.

METHODS

Konstruktor

new() - Instantiiere LaTeX Code-Generator

Synopsis

$l = $class->new;

Description

Instantiiere einen LaTeX Code-Generator und liefere eine Referenz auf dieses Objekt zurück.

Objektmethoden

protect() - Schütze LaTeX Metazeichen

Synopsis

$code = $l->protect($text);

Description

Schütze LaTeX-Metazeichen in $text und liefere den resultierenden Code zurück.

Liste/Erläuterung der LaTeX-Metazeichen: https://www.namsu.de/Extra/strukturen/Sonderzeichen.html

Examples

Dollarzeichen

$l->protect('Der Text $text wird geschützt.');

produziert

Der Text \$text wird geschützt.

env() - Erzeuge LaTeX-Umgebung

Synopsis

$code = $l->env($name,$body,@args);

Options

Siehe Methode $t->macro(). Weitere Optionen:

-indent => $n (Default: 2)

Rücke den Inhalt der Umgebung für eine bessere Quelltext-Lesbarkeit um $n Leerzeichen ein. Achtung: In einer Verbatim-Umgebung hat dies Auswirkungen auf die Darstellung und sollte in dem Fall mit -indent => 0 abgeschaltet werden.

Description

Erzeuge eine LaTeX-Umgebung und liefere den resultierenden Code zurück. Body $body und @args können in beliebiger Reihenfolge auftreten.

Examples

Document-Umgebung mit Text

$l->env('document','Dies ist ein Text.');

produziert

\begin{document}
  Dies ist ein Text.
\end{document}

section() - Erzeuge LaTeX Section

Synopsis

$code = $l->section($sectionName,$title);

Arguments

$sectionName

Name des LaTeX-Abschnitts. Mögliche Werte: 'part', 'chapter', 'section', 'subsection', 'susubsection', 'paragraph', 'subparagraph'.

Options

-label => $label

Kennzeichne Abschnitt mit Label $label.

-notToc => $bool (Default: 0)

Nimm die Überschrift nicht ins Inhaltsverzeichnis auf.

Description

Erzeuge ein LaTeX Section und liefere den resultierenden Code zurück.

Examples

Ein Abschnitt der Ebene 1

$l->section('subsection','Ein Abschnitt');

produziert

\subsection{Ein Abschnitt}

VERSION

1.135

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2019 Frank Seitz

LICENSE

This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.