Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-16610

Support Copy n Paste of Command Line commands in Ref Guide

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • main (10.0)
    • None
    • documentation
    • None

    Description

      From a discussion started in SOLR-16602, the suggestion is to remove $ from the command line examples in the docs to make the cut'n'paste option in the Ref Guide work for those commands.

      In doing more investigation, it turns out that in Antora, there is a formatting option where commands get some extra visual indications, and that the copy icon works the way you would expect. It will even handle not copying the output of a command, just the command itself!

      I am attaching two screenshots of the before and after, and the formatting changes.

      Attachments

        1. formatting differences.png
          37 kB
          Eric Pugh
        2. visual difference.png
          31 kB
          Eric Pugh

        Issue Links

          Activity

            People

              Unassigned Unassigned
              epugh Eric Pugh
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 2.5h
                  2.5h