IndexTargetRegistrar
in package
FinalYes
Makes a named `.. index::` block a target a `:ref:` can link to.
A :name: on the directive names the place the entries are filed under, so
the target points where the index does: at the section that follows the
block, or the document's own title when none does -- the same answer
IndexEntryCollector::placements() gives the index itself.
This cannot be left to the anchor handling a .. _label: gets. That runs
while the tree still holds the unprocessed directive, well before the
directive has been turned into an index node that could carry an anchor.
Table of Contents
Properties
- $anchorNormalizer : AnchorNormalizer
- $collector : IndexEntryCollector
- $logger : LoggerInterface
Methods
- __construct() : mixed
- registerAll() : void
Properties
$anchorNormalizer read-only
private
AnchorNormalizer
$anchorNormalizer
$collector read-only
private
IndexEntryCollector
$collector
$logger read-only
private
LoggerInterface
$logger
Methods
__construct()
public
__construct(IndexEntryCollector $collector, AnchorNormalizer $anchorNormalizer, LoggerInterface $logger) : mixed
Parameters
- $collector : IndexEntryCollector
- $anchorNormalizer : AnchorNormalizer
- $logger : LoggerInterface
registerAll()
public
registerAll(DocumentNode[] $documents, ProjectNode $projectNode) : void
Parameters
- $documents : DocumentNode[]
- $projectNode : ProjectNode