internote

A reference to another internote, written as a block on a line of its own.

On this page

#Block and inline

internote is one reference to another internote, written in either of two places: as a block on a line of its own, or inline inside a sentence as !internote. The two take the same attributes and do the same thing.

scene{
    internote(ref: Kq3vT8nWx2a)

    The interval rests on the sampling distribution of the mean, derived in
    !internote(ref: Kq3vT8nWx2a).
}

connect decides whether the reference builds the map's connections. It is on by default; !connect turns it off, and the reference is a link and nothing else (References as map edges).

scene{
    internote(ref: Pw7rD2mLs9b; !connect)

    The same statistic in a paired design is in !internote(ref: Pw7rD2mLs9b; !connect).
}

A callout's body refuses the block with node `internote` is not allowed here (allowed: paragraph, h1, h2, h3, h4, list, equation); inside a callout the reference is written inline.

A target that does not exist shows as Missing internote, with the id. One the reader is not allowed to see, or a draft they cannot open, shows without a link.

#Naming the internote

ref is the implicit attribute, and its value is the target's id: internote(ref: Kq3vT8nWx2a), or !internote:Kq3vT8nWx2a() inline.

In an internote published from a Git repository, ref can instead be a path to another .chalk file: a value beginning ./ or ../, or ending .chalk, resolved from the file it is written in. The repository sync replaces it with the id of the internote that file publishes, in the published copy only — the source keeps the path. A path that matches no internote in the repository, or leads out of it, is reported as a warning on the sync. A file that is not there yet is resolved on the push that adds it. Paths are resolved only by the sync, so outside a repository a reference is an id.

#Connections and maps

When the internote is published, each reference with connect on — the default — is recorded as a connection to the internote it names, and a map holding both draws that connection as an edge. !connect makes the reference a link and nothing else.Maps covers what a map is, how one is made, and how its connections are drawn and arranged.


#Attributes

refRequiredImplicit
The target internote's id. In an internote synced from a Git repository, a path to another .chalk file in the repository, such as ./limits.chalk, is also accepted: the sync resolves it to that internote's id, and reports a path that matches none as a warning.
Also written: internoteCan be written as shorthand: internote:value
connect
Whether the reference is recorded as a connection between the two internotes. !connect links without connecting.
Defaulttrue

#Allowed in

#Examples

internote(ref: Kq3vT8nWx2a)
internote(ref: ./limits.chalk)
internote(ref: Kq3vT8nWx2a; !connect)

#Notes

  • The same reference as !internote, which is written inline inside a sentence; the two take the same attributes.
  • A block stands in the narrative, not inside a callout or a list — write !internote there.
  • A target that does not exist shows as Missing internote, with the id. One the reader is not allowed to see, or a draft they cannot open, shows without a link.
  • With connect on, publishing the internote records the reference as a connection between the two. A map holding both draws a connection as an edge, in the order the references are written. A reference to the internote itself is not recorded.

#Writing guidance

Last updated