Display the documentation category in command pages

[DarkDragon]

Hello,

Source of this is here: viewtopic.php?p=630909#p630909

Maybe you can always show the current documentation category as breadcrumbs. E.g. at the top of InitMouse show "Overview" > "2D Games & Multimedia Libraries" > "Mouse" > "InitMouse" or so.

[AZJIO]

If you go to the section listing the functions, there is a description “Do not use the functions of this library in a regular application”.
It might be useful to make a section for sprites, as done here for World3D

[DarkDragon]

If you go to the section listing the functions, there is a description “Do not use the functions of this library in a regular application”.
It might be useful to make a section for sprites, as done here for World3D

Exactly but as Randy mentioned it's not visible EVERYWHERE. It could be, but it's not, e.g. if you open the help via F1 while being on a specific command.

[AZJIO]

it's not visible EVERYWHERE.

We'll end up describing the "Window" section on every gadgets page, because a beginner won't know how to use it. For others, this will be redundant information.

I don't see in the help:
1. regular expression syntax page.
2. flag (#TM_RICHTEXT) for EditorGadget to turn it into RTF.
3. Simplified and clear description of "Until 0 - endless loop" (While 1)
4. Keywords are missing in the help tree.
5. Difficult to find description of compiler command line options.

There are many more important things than duplicating the same text on all pages.

[DarkDragon]

There are many more important things than duplicating the same text on all pages.

I agree, request it, although TM_.. has nothing to do with PB itself but with Windows. Are breadcrumbs telling the answer "where in the documentation am I?" Really that lot of information that it's not worth showing? I am not saying add a disclaimer to every function saying "this is for games" or "this is for applications", but the location where you are inside the documentation.

[AZJIO]

I agree, request it, although TM_.. has nothing to do with PB itself but with Windows

Exception: RTF was previously used, which means users will search for information to restore the previous code. Naturally they will look for the EditorGadget function in the description. Perhaps they will look on the page for converting code 5.70 to 6.00.

Are breadcrumbs telling the answer "where in the documentation am I?" Really that lot of information that it's not worth showing?

The content tree on the left always shows where you are, except for some articles and keywords that are not listed in the tree.
Also on the page at the bottom there are links to the previous page, to the next page and to the table of contents.

[DarkDragon]

The content tree on the left always shows where you are, except for some articles and keywords that are not listed in the tree.
Also on the page at the bottom there are links to the previous page, to the next page and to the table of contents.

I usually browse the documentation on the web nowadays to be honest and miss it there, but yes you're right.