Log warning if footnoteref macro is found (unless compat mode is enabled) #3114
Comments
mojavelinux
added a commit
to mojavelinux/asciidoctor
that referenced
this issue
Mar 1, 2019
…nd compat mode is not enabled
mojavelinux
added a commit
to mojavelinux/asciidoctor
that referenced
this issue
Mar 1, 2019
…nd compat mode is not enabled
jboxman
added a commit
to jboxman-rh/openshift-docs
that referenced
this issue
Jun 10, 2020
openshift-cherrypick-robot
pushed a commit
to openshift-cherrypick-robot/openshift-docs
that referenced
this issue
Jun 12, 2020
jboxman
added a commit
to jboxman-rh/openshift-docs
that referenced
this issue
Jun 12, 2020
jboxman
added a commit
to jboxman-rh/openshift-docs
that referenced
this issue
Jun 12, 2020
jboxman
added a commit
to jboxman-rh/openshift-docs
that referenced
this issue
Jun 12, 2020
This was referenced Jun 12, 2020
Merged
Merged
jboxman
added a commit
to jboxman-rh/openshift-docs
that referenced
this issue
Jun 12, 2020
jboxman
added a commit
to jboxman-rh/openshift-docs
that referenced
this issue
Jun 12, 2020
commonquail
added a commit
to commonquail/git-mr-to
that referenced
this issue
Apr 5, 2021
Asciidoctor has preferred another way to write this style of footnotes
for years [1]. The general pattern of the change is
-footnoteref:[myid,my text].
+footnote:myid[my text].
[1] asciidoctor/asciidoctor#3114
commonquail
added a commit
to commonquail/commitmsgfmt
that referenced
this issue
Apr 5, 2021
Asciidoctor has preferred another way to write this style of footnotes
for years [1]. The general pattern of the change is
-footnoteref:[myid,my text].
+footnote:myid[my text].
However, unlike the footnoteref macro prints "my text" verbatim whereas
the footnote macro processes it like extra text, so the URL used here
has to be escaped to disable autolinking.
[1] asciidoctor/asciidoctor#3114
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The footnoteref macro has been replaced by the footnote macro with a target. This change was introduced in 1.5.7. Starting in 2.0.0, the processor should log a warning if the footnoteref macro is found, unless compat mode is enabled.
The warning should be fashioned after this example:
The preferred syntax is
footnote:idname[footnote text]. The reason for the warning is that the footnoteref macro doesn't follow the pattern of all the other macros and therefore propagates a misconception. For example, I've seen extensions model the syntax of a custom macro after footnoteref and I really don't want to discourage that. Consistency is key.The text was updated successfully, but these errors were encountered: