Classes, interfaces and traits

ConverterInterface

This interface provides a basic contract between the Converters and all classes that want to use them.

« More »

ToHtmlInterface

« More »

ToLatexInterface

Interface that dictates the custom options that all converters that convert to Latex should have.

« More »

ToPdfInterface

Interface that dictates the custom options that all converters that convert to Latex should have.

« More »

BaseConverter

« More »

Factory

This factory attempts to create a converter given an input and output format and return that.

use phpDocumentor\Plugin\Scrybe\Converter\ConverterFactory; use phpDocumentor\Plugin\Scrybe\Converter\Format\Format;

$converter_factory = new ConverterFactory();
$converter = $converter_factory->get(
    Format::MARKDOWN, Format::HTML
);

« More »

Classes, interfaces and traits

Document

This is a customized RestructuredText document to register Scrybe-specific directives, roles and options.

The following directives are introduced using this class:

  • toctree, a directive used to insert table of contents into documents.
  • image, an overridden version of image that collects the assets.
  • figure, an overridden version of the figure that collects the assets.

The following roles are introduced in this class:

  • doc, a reference to an external piece of documentation.
« More »

ToHtml

Class used to convert one or more RestructuredText documents to their HTML representation.

This class uses a two-phase process to interpret and parse the RestructuredText documents, namely Discovery and Creation.

« More »

Classes, interfaces and traits

CodeBlock

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.

This directive is inspired by Sphinx' toctree directive.

« More »

Figure

Directive used to process `.

. figure::` and collect images as assets to be copied.

The filenames of the images are taken from the directive and added onto the assets collection during the discovery phase. These assets may then be copied to the destination location by the invoker.

« More »

Image

Directive used to process `.

. image::` and collect images as assets to be copied.

The filenames of the images are taken from the directive and added onto the assets collection during the discovery phase. These assets may then be copied to the destination location by the invoker.

« More »

Toctree

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.

« More »

Classes, interfaces and traits

Doc

The :doc: role creates a link to an external document.

For this link you can either use relative locations or an absolute notation. The absolute notation uses the documentation root as starting directory.

« More »

Classes, interfaces and traits

Creator

A specialized RestructuredText Parser/Visitor to provide assistance methods for the creation phase.

.

« More »

Discover

A specialized RestructuredText Parser/Visitor to aid in the discovery phase.

This class collects all headings and their titles and populates the TableOfContents collection.

« More »

Classes, interfaces and traits

Collection

A Collection containing all different text-bases file formats that are supported by Scrybe, their mmime-types and available extensions.

« More »

Format

Defines a conversion format in Scrybe.

« More »

Classes, interfaces and traits

FormatNotFoundException

« More »

Classes, interfaces and traits

Definition

Defines the basic properties for a single conversion process.

« More »

Factory

Factory class that is able to return a contract between an input and output format (Definition).

« More »

Classes, interfaces and traits

Assets

This collection manages which assets were found during the discovery phase.

Each asset is represented by an entry containing the path to that asset relative to the project root.

« More »

Glossary

The glossary is a collection containing a collection of terms and uses that were discovered during the discovery phase.

The key of this collection is the term that was discovered and the value is an array of locations where the term was used.

The array of locations consists of a filename as key and an array with the linenumbers where the term occurred.

Example:

array(1) { ["term"]=> array(1) { ["filename"]=> array(3) { [0]=> int(10) [1]=> int(14) [2]=> int(20) } } }

« More »

TableOfContents

This collection manages which headings were discovered during the discovery phase and stores them as entries.

« More »

Classes, interfaces and traits

BaseEntry

The Table of Contents entry provides essential information on the current entry, it's place in the structure and where it points to.

« More »

File

The Table of Contents File describes a file and the headings it contains.

A File may also contain other files, those will serve as containers for more headings or other files. This way it is possible to 'include' another File as part of a hierarchy and have a integrated table of contents.

« More »

Heading

The Table of Contents File describes a headings and the Files and subentries it may contain.

A Heading may also contain files, those will serve as containers for more headings or other files. This way it is possible to 'include' another File as part of a hierarchy and have a integrated table of contents.

« More »

Module

The Table of Contents module represents an independent section of the documentation.

« More »

Classes, interfaces and traits

ConverterNotFoundException

Exception indicating that a requested Converter could not be found.

« More »