Quiq::Sdoc::Producer - Sdoc-Generator
Quiq::Hash
Ein Objekt der Klasse repräsentiert einen Sdoc-Generator. Die Methoden der Klasse erzeugen die Konstrukte, aus denen ein Sdoc-Dokument aufgebaut ist.
Einrücktiefe bei der Codegenerierung
$gen = $class->new(@keyVal);
Instantiiere einen Sdoc-Generator mit den Eigenschaften @keyVal (s. Abschnitt Attributes) und liefere eine Referenz auf dieses Objekt zurück.
Generiere Sdoc mit Einrückung 2:
$gen = Quiq::Sdoc::Producer->new( indentation => 2, );
$str = $gen->code($text,@keyVal);
Text des Code-Abschnitts.
Eigenschaften des Code-Abschnitts.
Erzeuge einen Code-Abschnitt mit Text $text und liefere den resultierenden Sdoc-Code zurück.
$gen->code("Dies ist\nein Test\n");
erzeugt
| Dies ist\n | ein Test.\n |\n
$str = $gen->comment($text);
Erzeuge einen Kommentar mit dem Text $text und liefere den resultierenden Sdoc-Code zurück.
$gen->comment("Dies ist\nein Test\n");
# Dies ist\n # ein Test.\n \n
$str = $gen->document(@keyVal);
Erzeuge eine Dokument-Definition mit den Eigenschaften @keyVal und liefere den resultierenden Sdoc-Code zurück.
$str = $gen->format( $format => $code, ... );
Erzeuge einen Format-Abschnitt für die angegebenen Format/Code-Paare und liefere den resultierenden Sdoc-Code zurück.
$str = $gen->link($name, url => $url, ... );
Erzeuge ein Link-Segment. Intern wird die Link-Defínition gespeichert, die später mit allen anderen Link-Definitionen per $gen->linkDefs() abgerufen werden kann.
$str = $gen->linkDefs;
Generiere Link-Definitionen zu den Link-Segmenten des Dokuments und liefere diese zurück. Die Methode wird typischerweise am Ende des Dokuments gerufen.
$str = $gen->paragraph($text);
Erzeuge einen Paragraph mit Text $text und liefere den resultierenden Sdoc-Code zurück.
$gen->paragraph("Dies ist\nein Test\n");
|Dies ist\n |ein Test.\n |\n
$str = $gen->table(\@titles,\@rows,@keyVal); # mit Titelzeile $str = $gen->table($width,\@rows,@keyVal); # ohne Titelzeile $str = $gen->table($text,@keyVal);
(Array of Strings) Liste der Kolumnentitel
(Array of Arrays of Strings) Liste der Zeilen
(Integer) Anzahl der Kolumnen
(String) Tabellen-Body als Text
(Pairs of Strings) Liste von Tabellen-Eigenschaften
(String) Sdoc-Code
Erzeuge eine Tabelle mit den Titeln @titles und den Zeilen @rows bzw. dem Tabellen-Body $text sowie den Eigenschaften @keyVal und liefere den resultierenden Sdoc-Code zurück.
$str = $gen->table(['Integer','String','Float'],[ [1, 'A', 76.253], [12, 'AB', 1.7 ], [123,'ABC',9999 ], ]); ==> %Table: Integer String Float ------- ------ -------- 1 A 76.253 12 AB 1.700 123 ABC 9999.000 . \n
$str = $gen->tableOfContents(@keyVal);
Erzeuge eine Inhaltsverzeichnis-Definition mit den Eigenschaften @keyVal und liefere den resultierenden Sdoc-Code zurück.
$str = $gen->section($level,$title,@keyVal); $str = $gen->section($level,$title,@keyVal,$body);
Erzeuge einen Abschnitt der Tiefe $level mit dem Titel $title und dem Abschnitts-Körper $body und liefere den resultierenden Sdoc-Code zurück.
$gen->section(2,'Test',"Dies ist\nein Test.");
== Test\n \n Dies ist\n ein Test.\n \n
$str = $gen->definitionList(\@items);
Erzeuge eine Definitions-Liste mit den Elementen @items (Array von Schlüssel/Wert-Paaren oder von zweielementigen Sub-Arrays) und liefere den resultierenden Sdoc-Code zurück.
Die Aufrufe
$gen->definitionList([A=>'Eins',B=>'Zwei']);
oder
$gen->definitionList([['A','Eins'],['B','Zwei']]);
erzeugen
[A]:\n Eins\n \n [B]:\n Zwei\n \n
Endet der Schlüssel mit einem Doppelpunkt, wie bei den Aufrufen
$gen->definitionList(['A:'=>'Eins','B:'=>'Zwei']);
$gen->definitionList([['A:','Eins'],['B:','Zwei']]);
steht der Doppelpunkt in der Klammer
[A:]\n Eins\n \n [B:]\n Zwei\n \n
was bedeutet, dass dieser mit gesetzt wird.
$str = $gen->eof;
Erzeuge einen EOF-Kommentar und liefere den resultierenden Sdoc-Code zurück.
$gen->eof;
# eof\n
1.204
Frank Seitz, http://fseitz.de/
Copyright (C) 2022 Frank Seitz
This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Quiq, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Quiq
CPAN shell
perl -MCPAN -e shell install Quiq
For more information on module installation, please visit the detailed CPAN module installation guide.