Uploaded image for project: 'Snowstorm'
  1. Snowstorm
  2. STORM-1018

Documentation and error messaging for External Editor Feature in Viewer 2.5

    Details

    • Type: Defect
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: Viewer 2.5.0
    • Fix Version/s: Sprint 12
    • Labels:
      None
    • Environment:
      Windows 7, Viewer 2.5
    • Approvals:
      Code Review, Product Owner
    • Acceptance Criteria:
      Hide
      Test cases:
      1. Use a path containing spaces without enclosing it with double quotes (/path to/editor).
         Expected: the "not found" message.
      2. Specify empty path ().
         Expected: the "not found" message.
      3. Try using an odd number of double quotes ("/path to/editor "%s").
         Expected: the "parse error" message.
      4. Specifying a nonexistent editor (/non/existent/editor).
         Expected: the "not found" message.
      5. Specify a valid editor path (/usr/bin/editor).
         Expected: the editor is executed.

      The command can be specified with the ExternalEditor debug setting or an environment variable: LL_SCRIPT_EDITOR for script editor and LL_XUI_EDITOR for the XUI preview tool. In the latter case you can also override the command via the "Editor Path" floater input field. See STORM-52 for more details.
      Show
      Test cases: 1. Use a path containing spaces without enclosing it with double quotes (/path to/editor).    Expected: the "not found" message. 2. Specify empty path ().    Expected: the "not found" message. 3. Try using an odd number of double quotes ("/path to/editor "%s").    Expected: the "parse error" message. 4. Specifying a nonexistent editor (/non/existent/editor).    Expected: the "not found" message. 5. Specify a valid editor path (/usr/bin/editor).    Expected: the editor is executed. The command can be specified with the ExternalEditor debug setting or an environment variable: LL_SCRIPT_EDITOR for script editor and LL_XUI_EDITOR for the XUI preview tool. In the latter case you can also override the command via the "Editor Path" floater input field. See STORM-52 for more details.

      Description

      I have looked around and have only discovered this documented by people in the forums which is why I have tagged this as a documentation issue. The process of setting up the external editor needs to be more clearly defined.

      However, assuming that I have taken the correct steps by adding my choice of editor within the Debug Settings ,externalEditor setting, followed by an "%s", and also provided it in the LL_SCRIPT_EDITOR in the environmental variables... despite doing these two things, the following dialog pops up and for the life of me, I don't know how I can follow these instructions any closer.

      "Select an editor by setting the environment variables LL_SCRIPT_EDITOR or the ExternalEditor setting."

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. STORM-52 As a Scripter, I want to use my own external script editing tools that provide more functionality than the inworld script editor.

          • Minor - An issue that could (or did) cause small or negligible consequences. Easy to recover or workaround. For example: misleading error messages, displaying output in a font or format other than what the resident desired.
          • Closed

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                darksnow.petrovic Darksnow Petrovic
                Extended Group Visibility:
                jira-users
                Prod Owner Approved:
                Grumpity ProductEngine
              • Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 2 hours, 30 minutes
                  2h 30m