Help file

[ANA KHAILFI]

Hi,
I need your help please!!
I'm thinking of writing help files for the Stata programs I've been working on, and was wondering if anyone could point me to some useful material on getting started. Best regards

[Nick Cox]

http://www.stata.com/manuals14/u18.pdf 18.11.6

This is already within your Stata installation as part of the .pdf documentation.

[ANA KHAILFI]

thank you very much!!!

[ANA KHAILFI]

Hello,
I try to excute my helpfile but i have an error message :
"program error: code follows on the same line as open brace"

When i excute only this part of programme :

{smcl}
{* *! version 14.1 20juin2016}{...}
{vieweralsosee "[R] help" "help help "}{...}
{viewerjumpto "Syntax" "myhelpfile##syntax"}{...}
{viewerjumpto "Description" "myhelpfile##description"}{...}
{viewerjumpto "Options" "myhelpfile##options"}{...}
{viewerjumpto "Remarks" "myhelpfile##remarks"}{...}
{viewerjumpto "Examples" "myhelpfile##examples"}{...}
{title:Title}

[Nick Cox]

You don't execute help files: you view them using help

[ANA KHAILFI]

but when i tape help my command
"help not found"
I saved the helpfile in the same directory of . ado

In another term,

what are the steps after writing the program ?

[Nick Cox]

If you write a program say frog the .ado and .sthlp

frog.ado
frog.sthlp

should go in the f folder of what adopath calls PERSONAL. See [U] 18.11.6.

If toad then the t folder etc.

If you do that then

help frog

should show you the help file.

[ANA KHAILFI]

thank you very much i will try it!!!
I'm so happy
It is ok
thank you N.Cox