scilab/modules/helptools/tests/unit_tests/helpbrowser.tst

   1 // =============================================================================
   2 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
   3 // Copyright (C) 2020 - Samuel GOUGEON
   4 //
   5 //  This file is distributed under the same license as the Scilab package.
   6 // =============================================================================
   7
   8 // <-- INTERACTIVE TEST -->
   9
  10 // help browser
  11
  12 // ----------------------------------------
  13 // Switching the language: Menu "Languages"
  14 // ----------------------------------------
  15 help ones
  16 //  - Switch the language.
  17 //  - CHECK that the same page is displayed in the help browser in the
  18 //    required language, for the main 5 supported languages.
  19
  20 // -------------------------------------
  21 // Seeing the page online: Menu "Online"
  22 // -------------------------------------
  23 //  - Be sure to have an active internet connexion
  24
  25 // Page of a native function
  26 // .........................
  27 help ones
  28 //  - Select "See this page online"
  29 //  - CHECK:
  30 //    - Your web browser must open
  31 //    - The online version of the page must be displayed
  32 //      - for the current helpbrowser language
  33 //      - for the current Scilab version
  34
  35 // Page of a section summary
  36 // .........................
  37 // - In the help browser, display a section summary
  38 // - Select the "Online" menu
  39 // - CHECK: a modal messagebox must open, saying
  40 //   "Help browser: Tables of contents can't be displayed online"
  41 //   The box is modal: you must click "OK" to close it and unlock Scilab
  42
  43 // Plain page from an external module
  44 // ..................................
  45 // Be sure that an external module with help pages is loaded
  46 // - In the help browser, display a plain page of the external module
  47 // - Select the "Online" menu
  48 // - CHECK: a modal messagebox must open, saying
  49 //   "Help browser: Pages of external modules can't be viewed online"
  50 //   The box is modal: you must click "OK" to close it and unlock Scilab
  51
  52 // -----------------------------------------------------
  53 // List related bugs declared on bugzilla: Menu "Issues"
  54 // -----------------------------------------------------
  55 //  - Be sure to have an active internet connexion
  56 //
  57 // Issues about a native function
  58 // ..............................
  59 help plot2d
  60 // a) Select the menu "Issues => List ALL issues declared for this item (online)"
  61 //   CHECK:
  62 //   * Your web browser must open
  63 //   * The listed items must all have "plot2d" in their summary
  64 //   * Unresolved issues must be listed first, sorted by decreasing bug_id
  65 //   * Resolved issues must then be listed. Their list is sorted
  66 //     a) by resolution status b) by decreasing bug_id
  67 // b) Select the menu "Issues => List only UNRESOLVED issues declared for this item (online)"
  68 //   CHECK:
  69 //   * Your web browser must open
  70 //   * The listed items must all have "plot2d" in their summary
  71 //   * Only UNRESOLVED issues must be listed, sorted by decreasing bug_id
  72 //     This includes NEW, ASSIGNED, and REOPENED issues
  73
  74 // Issues about a section summary
  75 // ..............................
  76 // * Display a section summary in the help browser
  77 // * Select any item in the "Issues" menu
  78 // * CHECK: a modal messagebox must open, saying
  79 //   "Help browser: Tables of contents can't be displayed online"
  80
  81 // Issues about an external feature
  82 // ................................
  83 // Be sure that an external module with help pages is loaded
  84 // * Display a section summary in the help browser
  85 // * In the help browser, display a plain page of the external module
  86 // * Select any item in the "Issues" menu
  87 // * CHECK: a modal messagebox must open, saying
  88 //   "Help browser: Bugs of external modules can't be listed"