Skip to content

Commit 2666cf3

Browse files
committed
Media: improve docs for authors
1 parent 5ab43f5 commit 2666cf3

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
@@ -638,9 +638,13 @@ There are currently three kinds of medias: image, audio, and
638638
video. Each of them can refer to the file either using an asset
639639
reference, or a direct link.
640640

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

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

0 commit comments

Comments
 (0)