Uploaded image for project: 'AMQ Documentation'
  1. AMQ Documentation
  2. AMQDOC-2163

Internal - Investigate support for / add callouts to code examples

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Won't Do
    • Icon: Major Major
    • None
    • 7.0
    • Interconnect DOC, Internal
    • None

      We'd like to use callouts in our code samples to highlight certain output that's especially meaningful to customers. Callouts are supported in ASCIIdoc, but:

      • Dev collaborators found that commented-out callouts interfere with cut-and-paste
      • Also, we protect callout IDs with code comments (// <1>), but it seems that ccutil strips them out

      If we cannot properly apply and preserve callouts in textual examples, we need to use an alternate method (screen shots), which is costly maintenance.

              behardesty Ben Hardesty
              sjay@redhat.com Susan Jay
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: