TeamForge : Post

Forum Topic - "Summary of Functions" in help system needed:

View: as

Nikolsky Oleg(deleted)

03/14/2010 6:36 AM

post49427

"Summary of Functions" in help system needed

QNX 6.3.* had entry in help system "Summary of Functions", which included C-library functions names organized by 
categories: "Thread functions", "Real-time timer functions" and so on. It was very convenient for programmer when he 
searched most appropriate function for his program. 
Unfortunately, QNX 6.4.1 help system omitted this entry. Wouldn't it be reasonable to include "Summary of Functions" in 
further versions of QNX 
OS?

Steve Reid(deleted)

03/15/2010 9:23 AM

post49445

RE: "Summary of Functions" in help system needed

We moved the information from the summary of functions into the index,
and then expanded it (a function can now be listed under more than one
category). The index is also easier to keep up to date because it's
generated automatically from the index tags in the entry for each
function.


Steve Reid (stever@qnx.com)
Technical Editor
QNX Software Systems 
 

> -----Original Message-----
> From: Nikolsky Oleg [mailto:community-noreply@qnx.com] 
> Sent: Sunday, March 14, 2010 6:37 AM
> To: momenticsgs-community
> Subject: "Summary of Functions" in help system needed
> 
> QNX 6.3.* had entry in help system "Summary of Functions", 
> which included C-library functions names organized by 
> categories: "Thread functions", "Real-time timer functions" 
> and so on. It was very convenient for programmer when he 
> searched most appropriate function for his program. 
> Unfortunately, QNX 6.4.1 help system omitted this entry. 
> Wouldn't it be reasonable to include "Summary of Functions" 
> in further versions of QNX 
> OS? 
> 
> 
> 
> _______________________________________________
> 
> QNX Momentics Getting Started
> http://community.qnx.com/sf/go/post49427
> 
>

Nikolsky Oleg(deleted)

03/15/2010 1:18 PM

post49497

Re: RE: "Summary of Functions" in help system needed

Yes, alphabetic index allows you to find information faster. But agree that it's difficult, not knowing the name of the 
function or utility, to find it. For example, I want to create a partition, format it and check for errors - in which 
letter I find the appropriate utilities? Or do I need to read information on all utilities, until I find one I want?

Steve Reid(deleted)

03/15/2010 2:40 PM

post49516

RE: RE: "Summary of Functions" in help system needed

Look for "partitions" in the index. 

Steve Reid (stever@qnx.com)
Technical Editor
QNX Software Systems 
 

> -----Original Message-----
> From: Nikolsky Oleg [mailto:community-noreply@qnx.com] 
> Sent: Monday, March 15, 2010 1:18 PM
> To: momenticsgs-community
> Subject: Re: RE: "Summary of Functions" in help system needed
> 
> Yes, alphabetic index allows you to find information faster. 
> But agree that it's difficult, not knowing the name of the 
> function or utility, to find it. For example, I want to 
> create a partition, format it and check for errors - in which 
> letter I find the appropriate utilities? Or do I need to read 
> information on all utilities, until I find one I want?
> 
> 
> 
> _______________________________________________
> 
> QNX Momentics Getting Started
> http://community.qnx.com/sf/go/post49497
> 
>

Steve Reid(deleted)

03/15/2010 3:16 PM

post49532

Re: RE: RE: "Summary of Functions" in help system needed

After rereading your posting, I think we might not be talking about the same thing when we refer to the "index". I mean 
the keyword index:

  http://www.qnx.com/developers/docs/6.4.1/neutrino/utilities/keywords-P.html

I suspect you mean the A-Z listings of the utilities:

  http://www.qnx.com/developers/docs/6.4.1/neutrino/utilities/utils-p.html

Steve Reid (stever@qnx.com)
Technical Editor
QNX Software Systems

Nikolsky Oleg(deleted)

03/16/2010 2:10 PM

post49636

Re: RE: RE: "Summary of Functions" in help system needed

While the keyword index is not quite what I'd like to have, anyway thanks for the answer.

Return