XmlDoc
API
Generated with
XmlDoc/com.phasmidsoftware.xmldoc/com.phasmidsoftware.xmldoc.idml/IdmlPackage

IdmlPackage

com.phasmidsoftware.xmldoc.idml.IdmlPackage
See theIdmlPackage companion object
class IdmlPackage

An open IDML package: a zip file plus its designmap.xml manifest, parsed only as far as discovering the other parts it references — everything is still fully generic at this stage (GenericElement), since no specialist types exist yet.

Value parameters

designmap

the parsed content of designmap.xml.

file

the underlying .idml file.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def loadPart(src: String): Try[GenericElement]

Method to load and generically parse a specific part, by its src path as it appears in parts (e.g. "Stories/Story_ue6.xml").

Method to load and generically parse a specific part, by its src path as it appears in parts (e.g. "Stories/Story_ue6.xml").

Value parameters

src

the path of the entry within the zip.

Attributes

Returns

a Try of GenericElement.

def loadParts(partType: String): Try[Seq[GenericElement]]

Method to load and generically parse every part of a given type (e.g. "Story").

Method to load and generically parse every part of a given type (e.g. "Story").

Value parameters

partType

the part type to filter on, e.g. "Story", "Spread".

Attributes

Returns

a Try of Seq[GenericElement], one per matching part, in designmap order.

def loadStories: Try[Seq[Story]]

Method to load every Story part referenced from designmap.xml.

Method to load every Story part referenced from designmap.xml.

Attributes

Returns

a Try of Seq[Story], in designmap order.

def loadStory(src: String): Try[Story]

Method to load a Story part and extract its Self identity and the rest of its content.

Method to load a Story part and extract its Self identity and the rest of its content.

Value parameters

src

the path of the Story entry within the zip (e.g. "Stories/Story_ue6.xml").

Attributes

Returns

a Try of Story.

Concrete fields

lazy val parts: Seq[PackagePart]

The package parts referenced from designmap.xml, i.e. its direct idPkg:* children. Every such reference observed in practice is a childless element with only a src attribute (e.g. ``).

The package parts referenced from designmap.xml, i.e. its direct idPkg:* children. Every such reference observed in practice is a childless element with only a src attribute (e.g. ``).

Attributes

Generated with