1. 26 Aug, 2021 1 commit
    • Albert Gräf's avatar
      Rework the index creation process. · 0e23379b
      Albert Gräf authored
      Pass 1 now iterates over the default hierarchy (either doc or the entire
      libdir) and the help path (if enabled) to determine names and locations
      of all help patches in the scope of the help browser (as set in the GUI
      preferences). This initial pass is needed, in particular, to resolve
      related object references in the meta data in pass 2.
      
      Pass 2 then iterates over all index entries constructed in pass 1,
      adding all the available meta data, including cross references to
      related objects. When pass 2 finishes, index construction is complete
      and the index cache is written to disk.
      
      Note the new revision of the help browser narrows indexing to just the
      -help.pd patches. Previous versions would index all .pd files. This may be
      subject to review, but the new indexing scheme is faster and produces less
      noise in the earch results (i.e., you won't see any helper abstractions or
      other patches which just happen to be bundled with the help patches).
      0e23379b
  2. 25 Aug, 2021 4 commits
    • Gabriela Bittencourt's avatar
      Add link to related_objects to each -help file · 9309710e
      Gabriela Bittencourt authored
      This adds clickable links (employing calls to pdgui.doc_open) to the
      help patches for related objects, if we can locate them. To support
      this, we add an initial scan of the help patches, recording their names
      and paths in the search index so that we can quickly look up their
      locations.
      
      NOTE: At present, the initial scan only covers the default hierarchy in
      libdir, regardless of what the actual scope of the browser set in the
      gui preferences and the help path is. Meta data will only be retrieved
      for the help patches discovered in the initial scan.
      9309710e
    • Gabriela Bittencourt's avatar
    • Gabriela Bittencourt's avatar
      Add related objects to the help index · 7e601d41
      Gabriela Bittencourt authored
      If an object has a "related objects" field in its help patch meta data,
      then the list of related objects will be added to the help index and
      will be displayed along with its description in the help browser.
      
      Moreover, objects will be listed in the search results if they have the
      search term as a related object. For instance, a search for 'pulse' will
      also list 'metro' because 'metro' has 'pulse' as a related object.
      
      Note that depending on the actual meta data, relatedness isn't
      necessarily symmetric. E.g., 'pulse' doesn't list 'metro' as a related
      object in turn and thus a search for 'metro' will *not* show 'pulse' in
      the search results, even though 'pulse' is related to 'metro'.
      7e601d41
    • Gabriela Bittencourt's avatar
      Bugfix: get rid of elasticlunr's default stop words · 76079f28
      Gabriela Bittencourt authored
      These interfere with incremental search (if an object name happens to be
      a stop word then it won't show in the search results), so we get rid of
      them.
      76079f28
  3. 05 Aug, 2021 2 commits
  4. 28 Jul, 2021 1 commit
  5. 19 Jun, 2021 1 commit
  6. 25 Apr, 2021 1 commit
  7. 24 Apr, 2021 1 commit
  8. 21 Apr, 2021 3 commits
  9. 18 Apr, 2021 1 commit
  10. 17 Apr, 2021 1 commit
  11. 16 Apr, 2021 4 commits
  12. 15 Apr, 2021 5 commits
  13. 14 Apr, 2021 1 commit
  14. 13 Apr, 2021 2 commits
  15. 10 Apr, 2021 10 commits
  16. 09 Apr, 2021 2 commits