Add simple reference documentation

[1fifoto]

Add simple reference documentation describing the layout of the tutorial as a Javascript object in alphabetical order by property. This would greatly help to better understanding the package's capabilities and potential. For example, something as simple as this indented list would help explain the depth and breadth of this package.

• string property - tutorial object
  • key: string - name of tutorial (used in checkpoint name)
  • complete: object - on completion object
  • on: string - comparison to be evaluated for completion where the string is:
    • 'checkpointReached' - check if checkpoint cookie exists
    • checkpoint: string - checkpoint name
    • 'form_submission' - check if form submitted with specific method and action URL
    • form: object
      • method: string - a regex matching pattern
      • url: string - a regex matching pattern
  • message: string - completion message text, or "paragraphs ``" for multiple paragraph text
  • title; string - completion title
  • steps: array - step objects
  • activeWhen: array - conditions to be met before becoming active
    • compare: string - comparison to be evaluated where the string is:
    • 'url' - match a URL
      • url: string - a regex matching pattern
    • 'inputVal' - check input equals value
      • selector: string - jquery selector string
      • value: string
    • 'inputNotVal' - check input does not equal value
      • selector: jquery string - jquery selector string
      • value: string
    • 'dropdownState' - check dropdown equals state
      • selector: string - jquery selector string
      • state: string
    • 'checkpointComplete' - check if checkpoint cookie exists
      • checkpoint: string property - checkpoint name
    • 'checkpointNotComplete' - check if checkpoint cookie does not exist
      • checkpoint: string - checkpoint name
    • 'either' - OR sub-compare
      • when: array - compare objects
    • 'all' - AND sub-compare
      • when: array - compare objects
  • annotate: string - component annotation text, or "paragraphs ``" for multiple paragraph text
    • annotateAfter: string - put annotation text after this jquery selector object
    • annotateBefore: string - put annotation text before this jquery selector object
    • annotateIn: string - put annotation text in this jquery selector object
    • annotateSkip: string - annotation skip button text
  • announce: string - full-screen announcement text, or "paragraphs ``" for multiple paragraph text
    • announceDismiss: string - announcement dismissal button text
  • editWhileOpen: boolean - allow component editing
  • highlight: string = highlight this jquery selector object
  • highlightBack: string - background color for this highlighted jquery selector object
  • key: string - name of step (used in checkpoint name)
  • title: string - title of tutorial (shown in bottom left control panel)

[jarekwg]

Hi 1fifoto,

Thanks for submitting such detailed issues! We don't at present have the resources to put much time into this package ourselves (we likely will again in the future at some point though eventually..), however if you want to go ahead and make a PR (for this or either of the other issues you've raised), we'll happily merge it in and publish a new version.

Cheers,

[1fifoto]

Hi jarekwg, Thanks for your response. I might take you up on your offer concerning a PR or two. A quick question regarding this one - ref doc. How would you prefer incorporating some more information: (1) add to the README.md or (2) add in a docs directory as markdown file or files or (3) add something else? if (2) then what filename would you prefer for the simple reference material shown above? Sincerely, Bri (AKA one-foot-in-front-of-the-other: 1fifoto)

[1fifoto]

Did a PR for a simple one line README.md file change. Trying out the PR process. Tell me if I did OK. It looks like it created a new issue so I probably should not put a preceding issue number such as I did. Future will change from "9 Minor: Fix built css in README" => "Minor: Fix built css in README"

[jarekwg]

Just in README.md is fine. If you have the energy to spin up something more elaborate, a docs folder is good, or a whole readthedocs setup thingy. :)

You can link to an existing issue in your PR description, using the magic words Fixes #<PR_NUMBER>, which will automatically close the issue when the PR is merged.

Cheers!