Skip to content

Commit be3e6f7

Browse files
panglesdjonludlam
authored andcommitted
Media: improve docs for authors
1 parent b6ff7bb commit be3e6f7

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

doc/odoc_for_authors.mld

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -639,9 +639,13 @@ There are currently three kinds of medias: image, audio, and
639639
video. Each of them can refer to the file either using an asset
640640
reference, or a direct link.
641641

642-
The markup is [{<media>:link}], [{<media>!ref}],
643-
[{{<media>:link}Replacement text}] and [{{<media>:ref}Replacement text}],
644-
where [<media>] is either [image], [video] or [audio].
642+
The markup for images is [{image:<link>}], [{image!<path>}],
643+
[{{image:<link>}Replacement text}] and [{{image!<path>}Replacement text}], where
644+
[<link>] is a link and [<path>] is a path to an asset. This path can be either
645+
relative or absolute.
646+
647+
The markup for videos and audios is similar, replacing [image] by respectively
648+
[video] and [audio].
645649

646650
The replacement text is used for backends that do not support medias
647651
(latex and man), and for when a reference is unresolved. In the case

0 commit comments

Comments
 (0)