HELP nit

May 20, 2008
3,515
4
Elkridge, MD, USA
All HELP versions, starting with V10, contain an "Index" entry "Regular
Expression Syntax". However, instead of linking to topic
"regularexpressionsyntax.htm" they link to topic "iniadvanceddlg.htm".
--
Steve
 
May 20, 2008
3,515
4
Elkridge, MD, USA
| ---Quote---
|| All HELP versions, starting with V10, contain an "Index" entry
|| "Regular Expression Syntax". However, instead of linking to topic
|| "regularexpressionsyntax.htm" they link to topic
|| "iniadvanceddlg.htm".
| ---End Quote---
| Correct; they're referring to the option on the Advanced page to set
| the RE syntax.

Since there is a topic titled the same as the index entry, IMHO it
should be linked to the matching topic; a separate index entry, e.g.,
"Choosing Regular Expression Syntax" should be linked to the option dialogs.
I was searching for a topic describing RE syntax, and the option dialog was
"off topic". Twice I got there and went back to the index to find the topic
of interest. Finally located it as one of the choices for index entry
"Regular expressions".
I have now crossed this hurdle, but novices would find alternate index
entries more intuitive.
--
Steve
 

rconn

Administrator
Staff member
May 14, 2008
12,340
149
> Since there is a topic titled the same as the index entry, IMHO it
> should be linked to the matching topic; a separate index entry, e.g.,
> "Choosing Regular Expression Syntax" should be linked to the option
> dialogs.

IMHO that'd be useless. I doubt anybody would start their search term with
"Choosing".

Rex Conn
JP Software
 
Similar threads
Thread starter Title Forum Replies Date
C Documentation Help Nit. REN / RENAME Support 0
R Documentation Help Nit with SETP Support 0
R Documentation Help Nit > bdebugger View Menu Support 0
vefatica Help nit Support 0
C Help Nit Support 0
vefatica Help nit (FFIND and DIR with /S) Support 0
vefatica Help nit Support 0
C Help 'nit Support 0
vefatica v20 help nit Support 12
vefatica Quick help nit Support 0
S Documentation HELP nit: @LINES Support 5
S Documentation HELP Nit - Index - Desktop command Support 0
vefatica IF PLUGIN (help nit?) Support 2
Charles Dye Documentation Another help nit Support 3
S Documentation HELP nit Support 0
Peter Bratton Help nit Support 11
S HELP nit: TOC error Support 0
vefatica Help nit Support 2
JohnQSmith Help nit Support 2
vefatica Help nit Support 1
S Help nit Support 0
S Help topic "f_wininfo.htm" - a nit Support 3
S HELP nit Support 0
S HELP nit Support 0
S HELP nit Support 0
S HELP nit Support 1
S HELP nit and suggestion Support 2
vefatica Another help nit Support 12
J Help nit Support 2
samintz How to? Search for %(command) in Help? Support 1
Joe Caverly Favorites in eWriter Help Support 6
Joe Caverly Quick Search in eWriter Help Support 1
vefatica Online help? Support 2
fishman@panix.com HELP!! I just updated to Version 28 and as usual I cannot make extended directory search work. Support 2
JohnQSmith New online help file wrong logo Support 7
Jay Sage Documentation Function @DRIVE Missing in Help Lists Support 0
Charles Dye More help nits Support 0
D Documentation Typo in COPY help Support 0
FreezerBurnt Help making a CMD and TCC compatible batch file Support 7
Joe Caverly Documentation COMMANDS in Version 27 help Support 8
K_Meinhard How to? Help window position Support 7
U Command help on file names Support 5
D Documentation Help "Startup" page does not describe global lists Support 0
vefatica Help disappears? Support 6
rchapmanitt Help Purchasing Support 2
Charles Dye Documentation Help nits: @ZIPFILECRC Support 0
C version help Support 3
Dmitry L. Kobyakov Documentation Error in the Help: the WINDOW command Support 0
vefatica Help for @PID Support 2
vefatica Need help with XML Support 3

Similar threads