Uploaded image for project: 'Quarkus'
  1. Quarkus
  2. QUARKUS-4290

Rewrite footnotes for downstream documentation

XMLWordPrintable

      The modern version of footnotes is not supported in the downstream tooling and we can't use the older version in our doc as it triggers warnings.
      Thus we rewrite the new format to the old format specifically for downstream doc.

      @MichalMaler I end up with the following diff, can you check this is what you expect?

      ```diff

      %% `%` Renders a simple `%` character.
      %c Category Renders the category name.
      -      		 %C Source class Renders the source class name.footnote:calc[Format sequences which examine caller information may affect performance]
      +      		 %C Source class Renders the source class name.footnoteref:[calc, Format sequences which examine caller information may affect performance]
      %d {xxx} Date Renders a date with the given date format string, which uses the syntax defined by `java.text.SimpleDateFormat`.
      %e Exception Renders the thrown exception, if any.
      -      		 %F Source file Renders the source file name.footnote:calc[]
      +      		 %F Source file Renders the source file name.footnoteref:[calc]
      %h Host name Renders the system simple host name.
      %H Qualified host name Renders the system's fully qualified host name, which may be the same as the simple host name, depending on operating system configuration.
      %i Process ID Render the current process PID.
      -      		 %l Source location Renders the source location information, which includes source file name, line number, class name, and method name.footnote:calc[]
      -      		 %L Source line Renders the source line number.footnote:calc[]
      +      		 %l Source location Renders the source location information, which includes source file name, line number, class name, and method name.footnoteref:[calc]
      +      		 %L Source line Renders the source line number.footnoteref:[calc]
      %m Full Message Renders the log message plus exception (if any).
      -      		 %M Source method Renders the source method name.footnote:calc[]
      +      		 %M Source method Renders the source method name.footnoteref:[calc]
      %n Newline Renders the platform-specific line separator string.
      %N Process name Render the name of the current process.
      %p Level Render the log level of the message.
      ```

            Unassigned Unassigned
            olubyans@redhat.com Alexey Loubyansky
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: