Details

    • Type: Task
    • Status: To-Do (View Workflow)
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:

      Description

      Right now the Command Socket App invites new users into dead ends. It gives an example script, but that script saves the example images to a folder that may not be intuitive to our users. If the user does get the example working, and wants to learn more, they are not given any hints about what to look for, and there is nothing to indicate that the scripting language CAN do more than what is in the example.

      We have page in the users guide that gives more detail about the scripting language. I think this detail is deliberately left out of the readme for the command socket to avoid duplication (avoid having multiple places to update if changes are made). But the readme should still direct users to the documentation in the users guide.
      https://wiki.transvar.org/display/igbman/Scripting+and+the+IGB+command+language

      Tasks:

      • Task 1. Improve the Command Socket documentation so that a user can easily locate the above page.
      • Task 2. Improve the example script to ensure that it can run on Windows computers in addition to MacOS and Linux computers

      I think replacing the current example script (in the Command Socket App readme) with the one I have attached to this issue will cover tasks 3 and 4. It removes all of the special characters from the file names (consider changing snapshotmainView to snapshot command). It saves the example images to a more readily accessed directory (need to make sure this path works on Windows and Linux). And it adds comments about how to reach the more complete documentation.

      Additional comment from Ivory:

      The script in the Readme of the Command Socket App is supposed to be a simple copy-and-paste job to get a script that demonstrates the functionality of the App.

      The script in the Command Socket readme does not work on our linux machine.
      I had to change the first line to use /bash rather than /sh.
      The /bash version works fine on both linux and mac (have not explored windows yet).
      This post offers some helpful explanation:
      https://unix.stackexchange.com/questions/45781/shell-script-fails-syntax-error-unexpected

        Attachments

          Issue Links

            Activity

            There are no comments yet on this issue.

              People

              • Assignee:
                Unassigned
                Reporter:
                ieclabau Ivory Blakley (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: