Stata The Stata listserver
[Date Prev][Date Next][Thread Prev][Thread Next][Date index][Thread index]

st: 'Linking' help files


From   Jesper Kjr Hansen <kjaer.hansen@oncable.dk>
To   <statalist@hsphsun2.harvard.edu>
Subject   st: 'Linking' help files
Date   Mon, 22 Nov 2004 14:02:39 +0100

Dear statalist members,

As I have not been able to find answers in the FAQ, prior postings to list
or in the manuals that I have available, I would appreciate any help or
pointers to help on the following.

I am in the process of writing help files for an ado-package, and I would
like to document two separate (but related) commands in the same .hlp file,
i.e. I would like to 'link' the .hlp files so that when I write:

-help ffdtstart- the file ffdtstart.hlp is shown,

and when I write:

-help ffdtset- the file ffdtstart.hlp is _also_ shown.

I seem to recall that this can be done by inserting a 'link' in the file
ffdtset.hlp, which points to ffdtstart.hlp - but since I can't find any
writing on this, I am not sure if it is doable?

I am aware that Stata controls this (for official commands) using the alias
files (ahelp_alias.maint, bhelp_alias.maint, ..., zhelp_alias.maint), but
how should it be handled for user-written packages (apart from the obvious
answers such as duplicating help file or inserting a clickable link)?

/Jesper



Regards,

Jesper Kjr Hansen
Student Assistant
Department of Statistics,
University of Southern Denmark
mailto:kjaer.hansen@oncable.dk

*---------------------------------------------*
| Call me with Skype: callto://kjaer.hansen   |
*---------------------------------------------*
  


*
*   For searches and help try:
*   http://www.stata.com/support/faqs/res/findit.html
*   http://www.stata.com/support/statalist/faq
*   http://www.ats.ucla.edu/stat/stata/



© Copyright 1996–2014 StataCorp LP   |   Terms of use   |   Privacy   |   Contact us   |   What's new   |   Site index