/ 
Prty-1.114
River stage zero No dependents
/ Prty::Sdoc::Document

NAME

Prty::Sdoc::Document - Sdoc-Dokument

BASE CLASS

Prty::Sdoc::Node

SYNOPSIS

Aufrufe zur Generierung eines Sdoc-Parsing-Baums:

$tree = Prty::Sdoc::Document->new($file);
$tree = Prty::Sdoc::Document->new(\$str);
$tree = Prty::Sdoc::Document->new(\@lines);

Aufrufe zur Generierung einer Repräsentation:

$str = $tree->dump('ehtml');
$str = $tree->dump('pod');
$str = $tree->dump('debug');

In einem Aufruf:

$str = Prty::Sdoc::Document->dump($format,$source);

DESCRIPTION

Die Klasse repräsentiert einen Sdoc-Parsingbaum.

METHODS

Konstruktor

new() - Konstruktor

Synopsis

$tree = $class->new($file,@opt);
$tree = $class->new(\$str,@opt);
$tree = $class->new(\@lines,@opt);

Description

Erzeuge einen Sdoc-Parsingbaum und liefere eine Referenz auf diesen zurück.

Options

-baseUrl => $url

Setze in den Kopf der HTML-Seite eine <base>-Tag mit dem angegebenen URL.

-centerTablesAndFigures => $bool (Default: 0)

Zentriere Abbildungen und Tabellen.

-comments => $bool (Default: 1)

Übergehe Zeilen, die mit '#' am Zeilenanfang beginnen.

-cssPrefix => $str (Default: 'sdoc')

Präfix für alle CSS-Bezeichner (Klassen- und Id-Bezeichner).

-deeperSections => $n (Default: 0)

Die Abschnitte werden um $n Schritte tiefer eingestuft.

-embedImages => $bool (Default: 0)

Bette Bilddaten in HTML ein.

-html4 => $bool (Default: 0)

Generiere HTML4 Code. Per Default wird XHTML Code generiert.

-minLnWidth => $n (Default: 1)

Minimale Breite der Listing Zeilennummern-Spalte in Zeichen.

-sectionNumbers => $bool (Default: 0)

Setze den Abschnittstiteln automatisch generierte Abschnittsnummern voran.

-styleSheet => $stylesheet (Default: sdoc.css)

Verwende Stylesheet $stylesheet, was ein URL sein oder Inline-Style "inline:FILE" sein kann. In letzterem Fall wird die angegebene Datei geöffnet und als Inline-Style zum Dokument hinzugefügt.

-tableAndFigureNumbers => $bool (Default: 0)

Stelle dem Titel "Tabelle N:" bzw. "Abbildung N:" voran.

-utf8 => $bool (Default: 0)

Der Text ist UTF-8 kodiert.

Objektmethoden

title() - Liefere den Titel des Dokuments

Synopsis

$title = $node->title;

Description

Der Titel kann bei Aufruf des Konstuktors mittels der Option -title angegeben werden. Andernfalls wird der Titel des ersten Abschnitts genommen. Hat das Dokument keinen Abschnitt, ist der Titel leer ('').

dump() - Erzeuge Repräsentation für Sdoc-Dokument

Synopsis

$str = Prty::Sdoc::Document->dump($format,$source);
$str = $node->dump($format,@opt);

Description

Erzeuge eine externe Repräsentation des Dokument-Knotens einschließlich aller Subknoten im Format $format und liefere diese an den Aufrufer zurück.

VERSION

1.114

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2017 Frank Seitz

LICENSE

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