Commit dfaa33a0 authored by Albert Gräf's avatar Albert Gräf

Rewording.

parent ec90fe82
......@@ -103,7 +103,7 @@ Permanent link: <a href="https://agraef.github.io/purr-data-intro/" class="uri">
<p>There are two options which let you change the scope of indexed patches:</p>
<ul>
<li><p>If “help browser only searches the doc folder” is checked (which is the default), then keyword searches are confined to the doc/ hierarchy. This is the fastest option and will be sufficient for novice users at least, as it covers all the official documentation that ships with Purr Data. However, if you’re an expert user and frequently use 3rd party externals living in the extra/ hierarchy, then you may want to uncheck this option to have all the remaining subdirectories in the pd-l2ork library directory indexed as well (note that this may slow down indexing considerably).</p></li>
<li><p>The “help browser also searches the help path” option, when checked, lets you tailor the keyword search to the externals you’re working with, so that you won’t be swamped with keyword matches from externals you never use. These externals may be located anywhere you choose, including the extra/ hierarchy (e.g., if they’re distributed with Purr Data), but note that if you’ve already unchecked the “help browser only searches the doc folder” option, then all the externals in extra/ will be searched anyway, so there’s no need to also add subdirectories of extra/ to the help path. In either case, you’ll have to add the directories to be searched to Purr Data’s <em>help path</em> (having them in the library search path is <em>not</em> enough). You do this using Purr Data’s <code>-helppath</code> option which can be added to the “startup flags” field at the bottom of the Startup tab. E.g., on Linux you may want to add something like <code>-helppath ~/pd-l2ork-externals</code> (that directory is often used on Linux for custom and personal external collections).</p></li>
<li><p>The “help browser also searches the help path” option, when checked, lets you tailor the keyword search to the externals you’re working with, so that you won’t be swamped with keyword matches from externals you never use. These externals may be located anywhere you choose, including the extra/ hierarchy, but note that if you’ve already unchecked the “help browser only searches the doc folder” option, then there’s no need to also explicitly add subdirectories of extra/. In either case, the directories to be searched with this option are set using Purr Data’s <em>help path</em> (having them in the library search path is <em>not</em> enough). You do this using Purr Data’s <code>-helppath</code> option which can be added to the “startup flags” field at the bottom of the Startup tab. E.g., on Linux you may want to add something like <code>-helppath ~/pd-l2ork-externals</code> (that directory is often used on Linux for custom and personal external collections).</p></li>
</ul>
<p><strong>Caveat:</strong> Again, be warned that changing these options and then installing external collections with gazillions of patches into either the extra/ hierarchy or on your personal help path may have a very negative impact on startup times, since all these patches will have to be scanned during index creation. Future Purr Data versions will hopefully provide some form of persistence and incremental updates of the search index to mitigate these effects. But for the time being, judicial use of the above options should in most cases give you a sensible setup which does not slow down index creation too much while fulfilling your documentation needs.</p>
<p>Also note that because the search index is created either during program startup or when the help browser is first launched, changing any of the help browser configuration options normally requires a restart of Purr Data to take effect.</p>
......
......@@ -142,7 +142,7 @@ There are two options which let you change the scope of indexed patches:
- If "help browser only searches the doc folder" is checked (which is the default), then keyword searches are confined to the doc/ hierarchy. This is the fastest option and will be sufficient for novice users at least, as it covers all the official documentation that ships with Purr Data. However, if you're an expert user and frequently use 3rd party externals living in the extra/ hierarchy, then you may want to uncheck this option to have all the remaining subdirectories in the pd-l2ork library directory indexed as well (note that this may slow down indexing considerably).
- The "help browser also searches the help path" option, when checked, lets you tailor the keyword search to the externals you're working with, so that you won't be swamped with keyword matches from externals you never use. These externals may be located anywhere you choose, including the extra/ hierarchy (e.g., if they're distributed with Purr Data), but note that if you've already unchecked the "help browser only searches the doc folder" option, then all the externals in extra/ will be searched anyway, so there's no need to also add subdirectories of extra/ to the help path. In either case, you'll have to add the directories to be searched to Purr Data's *help path* (having them in the library search path is *not* enough). You do this using Purr Data's `-helppath` option which can be added to the "startup flags" field at the bottom of the Startup tab. E.g., on Linux you may want to add something like `-helppath ~/pd-l2ork-externals` (that directory is often used on Linux for custom and personal external collections).
- The "help browser also searches the help path" option, when checked, lets you tailor the keyword search to the externals you're working with, so that you won't be swamped with keyword matches from externals you never use. These externals may be located anywhere you choose, including the extra/ hierarchy, but note that if you've already unchecked the "help browser only searches the doc folder" option, then there's no need to also explicitly add subdirectories of extra/. In either case, the directories to be searched with this option are set using Purr Data's *help path* (having them in the library search path is *not* enough). You do this using Purr Data's `-helppath` option which can be added to the "startup flags" field at the bottom of the Startup tab. E.g., on Linux you may want to add something like `-helppath ~/pd-l2ork-externals` (that directory is often used on Linux for custom and personal external collections).
**Caveat:** Again, be warned that changing these options and then installing external collections with gazillions of patches into either the extra/ hierarchy or on your personal help path may have a very negative impact on startup times, since all these patches will have to be scanned during index creation. Future Purr Data versions will hopefully provide some form of persistence and incremental updates of the search index to mitigate these effects. But for the time being, judicial use of the above options should in most cases give you a sensible setup which does not slow down index creation too much while fulfilling your documentation needs.
......
No preview for this file type
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment