Modify

Opened 5 years ago

Closed 5 years ago

#3049 closed Feature Request (Rejected)

Cross-referencing to assist in finding UDFs in the help

Reported by: c.haslam Owned by:
Milestone: Component: Documentation
Version: Severity: None
Keywords: Cc:

Description

I am starting this ticket because the topic has changed from Ticket 3042. I have downloaded the zip file offered there. Thank you.

I am aware, from the forum, that some users consider that there are too many UDFs. There are many, but with more cross-referencing, UDFs should be easier to find.

So, rather than just suggesting additions to the Related sections of Process built-in and UDF help pages (which I could easily suggest manually), I am working on a script to automate the process, to suggest links for many functions. The script is incomplete at this time, but will mature over the next week or two: I am trying to be careful not to include false links.

I am minimizing the number of links where I can. For example, for Process I will be suggesting that each help page for functions in native > Process Management, except Dll...(),

  • have a link to UDFs > Process Management.htm
  • have a link to each function in UDFs > WinAPI that has Process either in the name of the function or in its description
  • have a link to UDFs > .. > WinAPIEx Process Management

The scheme for adding links to UDFs > Process Management is similar.

I probably won't suggest adding links in Process function pages in UDFs > WinAPI and UDFs > .. > WinAPIEx Process Management

Your thoughts?

Attachments (2)

AutoRelate.txt (31.3 KB) - added by c.haslam 5 years ago.
Suggested links report
AutoRelate.2.txt (37.0 KB) - added by c.haslam 5 years ago.
Revised suggestion report: added links from GuiCreate…

Download all attachments as: .zip

Change History (6)

comment:1 Changed 5 years ago by TicketCleanup

  • Version 3.3.13.20 deleted

Automatic ticket cleanup.

Changed 5 years ago by c.haslam

Suggested links report

comment:2 Changed 5 years ago by anonymous

I have written a script that suggests what links there should be in what function help pages, and what they should be. This can be added to, to add links to .txt files. It works by matching words in management-file file names for native functions with UDF management-file file names. Where a management group is a mix, e.g. GUI Control Creation, it works at the function level.

This script is experimental. There is a partnership between it and me, to figure out what is needed. The report attached is my suggestion. It was generated by the script.

I took the approach of seeing what native functions should have links to what UDFs. I did some work on figuring out what UDFs should have links to native functions, but I failed to get this to work properly. I then realized that the UDF to native links are the reverse of the native to UDF links: one is the inverse of the other.

Your thoughts?

comment:3 Changed 5 years ago by anonymous

In the report, where Include is blank, all functions in the management group would have the link(s).

Changed 5 years ago by c.haslam

Revised suggestion report: added links from GuiCreate...

comment:4 Changed 5 years ago by guinness

  • Resolution set to Rejected
  • Status changed from new to closed

The help file is autogenerated, so your proposal is not possible. Thanks anyway.

Guidelines for posting comments:

  • You cannot re-open a ticket but you may still leave a comment if you have additional information to add.
  • In-depth discussions should take place on the forum.

For more information see the full version of the ticket guidelines here.

Add Comment

Modify Ticket

Action
as closed The ticket will remain with no owner.
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.