IDEAS home Printed from https://ideas.repec.org/p/boc/usug18/15.html
   My bibliography  Save this paper

Making help files the easy way

Author

Listed:
  • Adrian Mander

    (MRC Biostatistics Unit, University of Cambridge)

Abstract

The command makehlp was released in July 2012. It is a command for simplifying the construction of a help file by a SMCL help template. The command opens up the ado file and from the syntax line produces a template help file. In the past the user would need to edit this template and fill in the details such as the description, title, examples, etc. The new version of makehlp keeps the old functionality but also checks for the return codes to automatically produce a list of stored outputs. In addition a new syntax is introduced so that all the necessary text can be included in the ado file, for the various sections such as: description, title, examples, author, references, see also and all the options and returns descriptions. An example of the new syntax is desc[], which will place all the text between the brackets into the help file description and will be formatted as it is written, so SMCL commands are allowed. This means that the ado-file can store the majority of the help file and the help file can subsequently be created using this ado file.

Suggested Citation

  • Adrian Mander, 2018. "Making help files the easy way," London Stata Conference 2018 15, Stata Users Group.
    • Handle: RePEc:boc:usug18:15
    as

    Download full text from publisher

    File URL: http://repec.org/usug2018/makehlp.pdf
    File Function: presentation slides
    Download Restriction: no
    ---><---

    More about this item

    Statistics

    Access and download statistics

    Corrections

    All material on this site has been provided by the respective publishers and authors. You can help correct errors and omissions. When requesting a correction, please mention this item's handle: RePEc:boc:usug18:15. See general information about how to correct material in RePEc.

    If you have authored this item and are not yet registered with RePEc, we encourage you to do it here. This allows to link your profile to this item. It also allows you to accept potential citations to this item that we are uncertain about.

    We have no bibliographic references for this item. You can help adding them by using this form .

    If you know of missing items citing this one, you can help us creating those links by adding the relevant references in the same way as above, for each refering item. If you are a registered author of this item, you may also want to check the "citations" tab in your RePEc Author Service profile, as there may be some citations waiting for confirmation.

    For technical questions regarding this item, or to correct its authors, title, abstract, bibliographic or download information, contact: Christopher F Baum (email available below). General contact details of provider: https://edirc.repec.org/data/stataea.html .

    Please note that corrections may take a couple of weeks to filter through the various RePEc services.

    IDEAS is a RePEc service. RePEc uses bibliographic data supplied by the respective publishers.