Coderef

tags: src-block coderef annotation example-block

Description/Summary

Content

See Org Info: Literal Examples.

In literal examples, Org interprets strings like (ref:name) as labels, and use them as targets for special hyperlinks like [[(name)]] — i.e., the reference name enclosed in single parenthesis.

Line numbers are always enabled if coderefs are used. The code blocks are exported as if the user always added the -n switches to the source or example block header.

Source block #

Default line nums with coderef labels #

1
2

(save-excursion                 (sc)
   (goto-char (point-min))      (jump)

In line sc we remember the current position. Line jump jumps to point-min.

Default line nums without coderef labels #

1
2

(save-excursion
   (goto-char (point-min))

In line 1 we remember the current position. Line 2 jumps to point-min.

Custom line nums without coderef labels #

20
21

(save-excursion
   (goto-char (point-min))

In line 20 we remember the current position. Line 21 jumps to point-min.

Custom line nums without coderef labels and with highlighting #

20
21

(save-excursion
   (goto-char (point-min))

Line 21 jumps to point-min.

Reference to lines before code block #

In line 1 we remember the current position. Line 2 jumps to point-min.

1
2

(save-excursion
   (goto-char (point-min))

Example block #

20
21

(save-excursion
   (goto-char (point-min))

Line 21 jumps to point-min.

Page (Debug)

Page Params (Debug)

File Object (Debug)