Enhancement Requests about User Guide

[Bernhard S]

I guess it's better to keep enhancement requests about the User Guide in this separate thread.
In this post it was already requested that there should be an index in the User Guide added to find where certain issues are dealt with more quickly.

In addition I would like in the User Guide to see changes highlighted compared to the previous version and maybe differentiate between:
- completeley new or changed feature
- slightly changed behaviour
It would be great if those highlight are already visible in the table of contents. This should make it easier for users who are familiar with the previous version to get accustomed to the changes.

 

[Marco Kalter]

We'll consider this for the next release.

 

[null0000]

Marco,
version 9.0.6.1665 in fact does have older style .chm file to an addition User Guide in .pdf (as opposed to version 10.0.2.1697 )
I understand that in 2013 .chm is not sexy anymore , but is has searchable index as any header in file becomes an entry for an index.
so, with the next minor release of 10.x.x could you return that older style help file ? (with new content of course )

 

[Hilarion]

+1 for the idea of having .chm help/guide file format back!

 

[Marco Kalter]

I only see advantages to PDF. It is perfectly searchable (especially with advanced search), printable, zoomable, portable, and so on.

 

[Hilarion]

.chm made context help possible. When I had a problem with some specific PL/SQL Developer form I just had to press help button and immediately got help on that specific form. Now I'm presented with PDF document and I have to search for that form manually.

 

[null0000]

Marco , usability of .pdf VS .chm is debatable.
but if PLD is to use only 1 why there are still 2 options in menu Help in
10.0.4 and both invoke the same PDF help?
Again, index is still missing from PDF help.

 

[Marco Kalter]

.chm made context help possible. When I had a problem with some specific PL/SQL Developer form I just had to press help button and immediately got help on that specific form. Now I'm presented with PDF document and I have to search for that form manually.

If you are using Acrobat Reader you will be taken to the corresponding chapter, exactly like with the .chm file.

 

[Marco Kalter]

Marco , usability of .pdf VS .chm is debatable.
but if PLD is to use only 1 why there are still 2 options in menu Help in
10.0.4 and both invoke the same PDF help?
Again, index is still missing from PDF help.

The "PL/SQL Developer Help" menu item takes you to the chapter for the function you are currently using.

The "PL/SQL Developer User's Guide" menu item takes you to the contents.

Again, index is still missing from PDF help.

What kind of index do you mean?

 

[null0000]

Index I am searching for...
IMHO such index greatly improves usability, AND prevent constant search for some item from the top-to-the-bottom of the book.
Another words - "doing full table scan" all the time

 

[null0000]

The "PL/SQL Developer Help" menu item takes you to the chapter for the function you are currently using.

The "PL/SQL Developer User's Guide" menu item takes you to the contents.

Indeed, I do see the primary differences between functionality.
seems as I did not look closely at first - apologies.

 

[Hilarion]

If you are using Acrobat Reader you will be taken to the corresponding chapter, exactly like with the .chm file.

I do use Adobe Reader XI (v.11.0.3) and when I click "Help" button (in PL/SQL Developer v.10.0.4) for example on Tools / Preferences window, the PDF is opened on the first page. Same happens when I click Help / "Pl/SQL Developer Help" or Help / "PL/SQL Developer User's Guide".
Same thing happens for my co-workers (same PL/SQL Developer version, same Adobe Reader version).
From what you wrote it's not an intended behaviour.
Some people on my work team who use PL/SQL Developer do not use Adobe Reader (eg. Foxit Reader). Do you plan to make it work for them too?

I'm not saying that .chm is the best solution but for me it was better than PDF. I did read PDF as a manual (from the first page to the last one) but when it comes to searching for help in some specific situation, the .chm worked much better. I did not have to check where is the description of the problem I am facing and where that description ends - everything was on one single help page. I had an index, a search function and the table of contents. Everything nicely separated but working together. What was also great that the same mechanism works in many other applications in the very same way that I'm used to.