Indexing of functions

A request for documentation to index the Servoy functions, both the online docs and printed.

Just now I found myself paging right through the docs looking for the correct terminology and parameters for “showFormInDialog”. It turned out to be under Application, which is logical but I don’t yet think entirely the way that Servoy thinks.

I’d like to be able to search through an index for this kind of thing.

Kind regards.

Morley:
A request for documentation to index the Servoy functions, both the online docs and printed.

Just now I found myself paging right through the docs looking for the correct terminology and parameters for “showFormInDialog”. It turned out to be under Application, which is logical but I don’t yet think entirely the way that Servoy thinks.

I’d like to be able to search through an index for this kind of thing.

Kind regards.

Morley,

In the Servoy on-line Help (F1 or Help from the Help menu), once you
have a Help Navigator section open, you can choose Tools > Find and
enter in any criteria (one or more characters) that you wish to search for.

Then press the “Find” button. The first instance of your search results will
display as highlighted.

Press the “Find” button again to find and highlight the
next instance of the criteria you are searching for…and so on.

Remember, however, that you do need to have a Help Navigator section
open first in order for the “Tools>Find” feature to work.


You also have searching capabilities in Acrobat Reader (6.0 was used as a
test) that can be used with any of the Servoy documentation available for
download in pdf format.

Once you have downloaded the desired Servoy document, open the pf file
in Acrobat Reader.

Choose Edit>Search.

When the Search panel appears, enter in your search criteria and press
the “Search” button. All of the results should appear as links in the search
panel.

Select the link you are interested in to move to that section of the pdf
document.


Marc Norman
Servoy

Online Search has highly inconsistent results. A sampling of what can’t be found:

writeFile
undo
showURL
writeTEXTfile
writeXMLfile
showColorChooser
setWindowSize
setWindowLocation

Partials such as WindowLocation, TEXTfile or FormInDialog also don’t.

This request is not intended as a criticism but a request which would enhance functionality. A fully searchable index of functions, including partials, would be a most welcome addition to Servoy.

Kind regards.

Morley:
Online Search has highly inconsistent results. A sampling of what can’t be found:

writeFile
undo
showURL
writeTEXTfile
writeXMLfile
showColorChooser
setWindowSize
setWindowLocation

Partials such as WindowLocation, TEXTfile or FormInDialog also don’t.

This request is not intended as a criticism but a request which would enhance functionality. A fully searchable index of functions, including partials, would be a most welcome addition to Servoy.

Kind regards.

Morley,

Your suggestion is appreciated. We have been in the process of
investigating a means of providing this type of indexing for Servoy
functions in both Servoy’s online as well as written documentation
formats, as well as tying this information in a more dynamic way to the
Method Editor.

In the meantime, it is important to note that in Servoy’s online Help
Navigator (Help in the Help menu or F1), there are two “Search” options
that you can use.

The first option employs the “Search” tab.

Searching via the “Search” tab is restricted to finding one or more
characters that comprise the names of topics (chapters or sections) only.

The second option for searching employs the Tools>Find menu.
Choosing the “Find” menu displays a dialog that enables you to enter one
or more characters to find any item WITHIN a topic (chapter or section).

For example:

  1. Go to Help>Help or F1 to open the Servoy Help Navigator.
  2. Open the Help Navigator Contents tab.
  3. Double click the Methods chapter icon to expand the Methods sections.
  4. Doubleclick to view the content on Methods: Application.
  5. Go to Tools>Find (CTRL+F).
  6. Enter “write” in the “Find What” box.
  7. Press the “Find Next” button.

The first item that is highlighted in the right-hand content panel
is “application.writeFile”.

You can find more detail about using the Servoy Help Navigator in the
Servoy online Help by choosing Appendix and then opening the section
called The Servoy Help Navigator; this same information is available in
the pdf and printed book versions of Servoy Developer Edition Volume 1:
User’s Guide. In the printed book, The Servoy Help Navigator section
begins on page 597 and continues through page 609; and the explanation
about the Servoy Help Find dialog can be found on page 608.


Marc Norman
Servoy

Thanks for your feedback.

The Find command appears to search the text of the current selected topic only, doesn’t search universally.

Due to my sheer greenness with Servoy there are many occasions where I’m not at all sure within what heading a particular function lies. Case in point yesterday’s search for the full name and available parameters for FormInDialog.

It would greatly help to index all Servoy functions independently of chapters or sections. Hope you can find a solution to this problem.

Best wishes.

Morley:
Thanks for your feedback.

The Find command appears to search the text of the current selected topic only, doesn’t search universally.

Due to my sheer greenness with Servoy there are many occasions where I’m not at all sure within what heading a particular function lies. Case in point yesterday’s search for the full name and available parameters for FormInDialog.

It would greatly help to index all Servoy functions independently of chapters or sections. Hope you can find a solution to this problem.

Best wishes.

As of Servoy 2.1rc4, all Servoy functions will be added to the index
for both the Servoy printed documentation and online Help.

Once this enhancement is made available, here are the steps to
follow to search for a specific Servoy function in Servoy Help online:

  1. Open the Servoy Help Navigator (Help>Help menu or F1).

  2. Select the “Index” tab.

  3. Type the first few letters of the Servoy function you are looking
    for help with - the lndex list is “type-ahead” enabled.

  4. Select the desired Servoy function from the Index list
    (located at the top of the left panel).

  5. Doubleclick on the desired topic from the Topic list
    (located at the bottom of the left panel).

  6. Go to Tools>Find (CTRL-F).

  7. Enter in one or more search criteria characters in “Find What”.

  8. Click the “Find Next” button.

  9. The first instance of the search criteria you entered will be displayed and highlighted.

  10. Press the “Find Next” button again to display and highlight each
    additional instance of the search criteria you entered - WITHIN THE
    ACTIVE (OPEN) TOPIC.

  11. To search for the entered search criteria in other topics, you will need
    to first select and open the topic.


Marc Norman
Servoy