NAME
Prty::Sdoc::Section - Abschnittsüberschrift
BASE CLASS
DESCRIPTION
Ein Objekt der Klasse repräsentiert einen Abschnitt im Sdoc-Parsingbaum.
ATTRIBUTES
- parent => $parent
-
Verweis auf Superknoten.
- childs => \@childs
-
Liste der Subknoten.
- level => $n
-
Tiefe des Abschnitts in der Abschnittshierarchie, beginnend mit 1.
- number => $str
-
Nummer des Abschitts in der Form N.N.N (abhängig von der Ebene). Der Attributwert wird automatisch generiert.
- title => $str
-
Titel des Abschnitts.
- key => $str
-
Verlinkungsschlüssel.
METHODS
Konstruktor
new() - Konstruktor
Synopsis
$node = $class->new($doc,$parent);Description
Erzeuge einen Section-Parsingbaum und liefere eine Referenz auf den Section-Knoten zurück.
Methods
numberAnchorText() - Liefere den Text des Nummern-Ankers des Abschnitts
Synopsis
$text = $node->numberAnchorText;
$text = $node->numberAnchorText($bool);Description
Wenn $bool wahr ist, kanonisiere den Text, so dass er als Wert eines Ankers eingesetzt werden kann.
visibleTitle() - Liefere den Abschnitts-Titel, wie er ins Dokument geschrieben wird
Synopsis
$text = $node->visibleTitle($format);dump() - Erzeuge externe Repräsentation für Section-Knoten
Synopsis
$str = $node->dump($format,@args);Description
Erzeuge eine externe Repräsentation des Section-Knotens einschließlich aller Subknoten im Format $format und liefere diese zurück.
VERSION
1.124
AUTHOR
Frank Seitz, http://fseitz.de/
COPYRIGHT
Copyright (C) 2018 Frank Seitz
LICENSE
This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.