help files
Z505 | PasWiki | FUQ | Search | Main Docs | API Guide



Notes

Search term:
(Advanced...)
This particular 'find tool' searches page titles (including procedure, function, class, record, type, and var names) only. A more advanced tool which searches within the documentation contents and actual notes will be available some time.

Simple Query API

See our static html page example with a form on it:

Or a simple URL request example:

Advanced Query API

Here are some advanced options for your URL query or FORM query.
  Apply Powtils API, RTL, FCL filter ON:   &fpcdocf=y
  Apply General Powtils Docs filter ON:    &maindocf=y
  Apply Unit Name (source file)filter ON:  &unitnamef=y
By default, all these filters are on when you do not specify the following:
  Advanced search filter: &adv=y
So a simple query does not require you put any filters on. When you add the adv=y param to the query it means if no filters are specified then nothing will be found.

CTRL-F1 Style Help

You can set up a text editor or IDE to have context sensitive help by making a new TOOL menu item. Set your tools menu item to open a web browser at the above URL using the editor's {$CurSelection}, CurToken, or CurWord style macro if your editor has one. Most IDE's and text editors have a 'current selection' or 'current token' or 'current word' macro. Most editor's support custom tools menu items, including EditPlus, Lazarus, latest MSEIDE SVN, and many others.

If you cannot use the shortcut CTRL-F1 in your editor since it is already taken, then try others such as ALT-H.

Other Tips

You can also use Google in the mean time, using the keywords 'lufdoc somefunction' or similar.

To do

Implement "space friendly" search.. for example this+text+here searches all pages with dashes or underscores in them. Currently pages are named like-this-here when there are spaces.

Implement full page content search.

Implement more checkboxes and features.






lufdoc, Powtils, fpc, freepascal, delphi, kylix, c/c++, mysql, cgi web framework docs, Z505