org.asciidoctor.ast

Interface DocumentRuby

All Superinterfaces:

AbstractBlock

All Known Implementing Classes:

Document

public interface DocumentRuby
extends AbstractBlock

Method Summary

Methods

Modifier and Type	Method and Description
boolean	basebackend(String backend)
List<AbstractBlock>	blocks()
Object	doctitle(Map<Object,Object> opts) Get doc title
Map<String,Object>	getAttributes()
String	title()

Methods inherited from interface org.asciidoctor.ast.AbstractBlock

attributes, content, context, convert, delegate, document, findBy, id, role, style

Method Detail

doctitle

Object doctitle(Map<Object,Object> opts)

Get doc title

Parameters:

options - to get the doc title. Key should be Ruby symbols.

Returns:

String if partition flag is not set to false or not present, Title if partition is set to true.

See Also:

Title

title

String title()

Specified by:

title in interface AbstractBlock

Returns:

page title

getAttributes

Map<String,Object> getAttributes()

Returns:

attributes defined in document

basebackend

boolean basebackend(String backend)

Returns:

basebackend attribute value

blocks

List<AbstractBlock> blocks()

Specified by:

blocks in interface AbstractBlock