Gitee
\
Cilex
Provider
phpDocumentor
Command
Helper
Phar
Project
Compiler
Linker
Pass
Configuration
Merger
Annotation
Console
Input
Output
Descriptor
Builder
Reflector
Tags
Cache
Example
Exception
Filter
Interfaces
ProjectDescriptor
Tag
BaseTypes
Type
Validator
Event
Parser
Command
Project
Configuration
Event
Exception
Util
Partials
Exception
Plugin
Core
Descriptor
Validator
Constraints
Classes
Functions
Property
Functions
Transformer
Behaviour
Tag
Writer
Xml
Xslt
Graphs
Writer
LegacyNamespaceConverter
Tests
Scrybe
Command
Manual
Converter
Definition
Exception
Format
Exception
Metadata
TableOfContents
RestructuredText
Directives
Roles
Visitors
Template
Twig
Writer
Transformer
Behaviour
Command
Project
Template
Configuration
Transformations
Event
Exception
Router
Matcher
UrlGenerator
Standard
Template
Writer
Exception
Translator

\phpDocumentor\Plugin\Scrybe\Converter\RestructuredText\DirectivesToctree

Directive used to process `.

. toctree::` and insert entries from the table of contents.

This directive tries to match the file with an entry in the table of contents during the creation phase. If a document is found it will generate a mini-table of contents at that location with the depth given using the :maxdepth: parameter.

Another option is :hidden: that will hide the toc from view while still making connections.

This directive is inspired by Sphinx' toctree directive.

Summary

Methods
Properties
Constants
__construct()
toDocbook()
toXhtml()
No public properties found
No constants found
parseLinks()
addLinksToTableOfContents()
getCaption()
$links
N/A
No private methods found
No private properties found
N/A

Properties

$links

$links :

Type

Methods

__construct()

__construct(\ezcDocumentRstDocumentNode  $ast,   $path, \ezcDocumentRstDirectiveNode  $node)

Parameters

\ezcDocumentRstDocumentNode $ast
$path
\ezcDocumentRstDirectiveNode $node

toDocbook()

toDocbook(\DOMDocument  $document, \DOMElement  $root) : void

Transform directive to docbook

Create a docbook XML structure at the directives position in the document.

Parameters

\DOMDocument $document
\DOMElement $root

toXhtml()

toXhtml(\DOMDocument  $document, \DOMElement  $root) : void

Transform directive to HTML

Create a XHTML structure at the directives position in the document.

Parameters

\DOMDocument $document
\DOMElement $root

parseLinks()

parseLinks()

addLinksToTableOfContents()

addLinksToTableOfContents()

getCaption()

getCaption(\ezcDocumentRstToken  $file_name) : string

Retrieves the caption for the given $token.

The caption is retrieved by converting the filename to a human-readable format.

Parameters

\ezcDocumentRstToken $file_name

Returns

string