Document

Instance Constructors

new Document(path: Path, content: RootElement, fragments: Map[String, Element] = ..., config: Config = ..., position: TreePosition = ...)

path
the full, absolute path of this document in the (virtual) document tree
content
the tree model obtained from parsing the markup document
fragments
separate named fragments that had been extracted from the content
config
the configuration for this document
position
the position of this document inside a document tree hierarchy, expressed as a list of Ints

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val config: Config

the configuration for this document
the configuration for this document

Definition Classes
Document → TreeContent
val content: RootElement

the tree model obtained from parsing the markup document
the tree model obtained from parsing the markup document

Definition Classes
Document → DocumentStructure
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val fragments: Map[String, Element]

separate named fragments that had been extracted from the content
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
lazy val globalLinkTargets: Map[Selector, TargetResolver]

All link targets that can get referenced from anywhere in the document tree.
All link targets that can get referenced from anywhere in the document tree.

Definition Classes
DocumentStructure
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
lazy val linkTargets: LinkTargetProvider

All link targets of this document, including global and local targets.
All link targets of this document, including global and local targets.

Definition Classes
DocumentStructure
lazy val name: String

The local name of this navigatable.
The local name of this navigatable.

Definition Classes
Navigatable
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val path: Path

the full, absolute path of this document in the (virtual) document tree
the full, absolute path of this document in the (virtual) document tree

Definition Classes
Document → Navigatable
val position: TreePosition

the position of this document inside a document tree hierarchy, expressed as a list of Ints
the position of this document inside a document tree hierarchy, expressed as a list of Ints

Definition Classes
Document → TreeContent
def rewrite(rule: RewriteRule): Document

Returns a new, rewritten document model based on the specified rewrite rule.
Returns a new, rewritten document model based on the specified rewrite rule.
If the specified partial function is not defined for a specific element the old element remains in the tree unchanged. If it returns None then the node gets removed from the tree, if it returns an element it will replace the old one. Of course the function may also return the old element.
The rewriting is performed in a way that only branches of the tree that contain new or removed elements will be replaced. It is processed bottom-up, therefore any element container passed to the rule only contains children which have already been processed.
lazy val sections: Seq[SectionInfo]

The section structure of this document based on the hierarchy of headers found in the original text markup.
The section structure of this document based on the hierarchy of headers found in the original text markup.

Definition Classes
DocumentStructure
def selectTarget(selector: Selector): Option[TargetResolver]

Selects a link target by the specified selector if it is defined somewhere in a document inside this document tree.
Selects a link target by the specified selector if it is defined somewhere in a document inside this document tree.

Definition Classes
TreeContent
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def title: Seq[Span]

The title of this document, obtained from the document structure or from the configuration.
The title of this document, obtained from the document structure or from the configuration. In case no title is defined in either of the two places the sequence will be empty.

Definition Classes
DocumentStructure
def titleFromConfig: Option[Seq[Span]]

Attributes
protected
Definition Classes
TreeContent
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

case class Document(path: Path, content: RootElement, fragments: Map[String, Element] = ..., config: Config = ..., position: TreePosition = ...) extends DocumentStructure with TreeContent with Product with Serializable

Instance Constructors

new Document(path: Path, content: RootElement, fragments: Map[String, Element] = ..., config: Config = ..., position: TreePosition = ...)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val config: Config

val content: RootElement

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val fragments: Map[String, Element]

final def getClass(): Class[_]

lazy val globalLinkTargets: Map[Selector, TargetResolver]

final def isInstanceOf[T0]: Boolean

lazy val linkTargets: LinkTargetProvider

lazy val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val path: Path

val position: TreePosition

def rewrite(rule: RewriteRule): Document

lazy val sections: Seq[SectionInfo]

def selectTarget(selector: Selector): Option[TargetResolver]

final def synchronized[T0](arg0: ⇒ T0): T0

def title: Seq[Span]

def titleFromConfig: Option[Seq[Span]]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from TreeContent

Inherited from Navigatable

Inherited from DocumentStructure

Inherited from AnyRef

Inherited from Any

Ungrouped