Rework Proposal

There are two types of Help currently: Documentation and Tutorial.

==General Thoughts==

• Both should be available off line, online, and as part of the GUI application
• Above means that sphinx should build a PDF as well HTML output SasView/sasview#643
• Re-order Menu list to move Analysis next to the perspective menu item it has chosen (currently only Fitting has a separate menu) SasView/sasview#648
• Rename Tool to Tools SasView/sasview#648

ISSUES:

• Model parameter names convention seems wrong?
• how do we deal with changing screen shots?

==Tutorial==

• Should redo completely around example data in SasView
• Tutorials for each topic that can then be bundled together if desired
  • Fitting
    • 1D SasView/sasview#651
    • 2D SasView/sasview#652
    • constrained SasView/sasview#653
    • simultaneous SasView/sasview#654
    • Batch SasView/sasview#655
  • Pr SasView/sasview#649
  • Invariant SasView/sasview#650

==Documentation==

• General help documentation
  • Remove all reference to term perspective which confuses users — replace with "Analysis" or other appropriate wording. SasView/sasview#646
  • Add a help topic on menu items (go through menu list) SasView/sasview#645
  • restructure tree to SasView/sasview#644
    • collapse tool help under a top level Tools entry
    • collapse Fitting, Pr an invariant into an Analysis heading
  • All of it should then be reviewed to verify for readability and that it matches the actual functionality (does pressing the button do what it says) SasView/sasview#647
• Model help documentation SasView/sasview#248
  • review for all models for
    • Clarity
    • That units on parameters are correct and properly formatted
    • That Equation matches what the code does
    • Completeness - elements of documentation are:
      • title
      • tool tip
      • Parameter table
      • Paragraph describing what the function does
      • equation used
      • Fig obtained when model is run with default parameters as listed in table above
      • Reference
      • NEW REQUIREMENT
        • Added by: name, ON: date
        • checked by: name, ON: date
        • modified by: name, ON: date
        • Can us name such as "DANSE" if old models with no name of who added, or source if imported from other package, etc.