@include

Splices an attached partial, a .part.chalk file, into the document where the directive is written.

@includeDirectiveExplained in Modularity
On this page

#Attributes

srcRequiredImplicit
The partial's file name, written as the implicit value (@include:overview.part.chalk) or as src:. A relative path is read from the including file's folder.
Can be written as shorthand: @include:value

#Examples

@include:overview.part.chalk
@include(src: overview.part.chalk)

#Notes

  • The partial's text takes the directive's place, in the scope the directive is written in: constants, datasets and templates it declares are visible after it as if written there.
  • Its content must be legal where it lands: a partial of scenes included inside a scene is refused at its first scene.
  • A partial carries no document header: the document header must be the first node of the document.
  • Errors inside a partial are reported at the partial's own file and line, overview.part.chalk:6.
  • A missing file is refused, included file not found: nope.part.chalk, and so is a partial that includes itself, directly or through another: circular include.
  • Including a partial twice declares its ids twice, which is a duplicate id error.
  • On the platform a partial is an attachment whose name ends .part.chalk; the other attachments are .csv and .geojson files for @data.

Last updated