-------------------------------------------------------------------------------
help for examples8, wexamples 
-------------------------------------------------------------------------------

Show examples from on-line help files

        examples8 topicname

        wexamples topicname

        examples8 function()

        wexamples function()


Description

    examples8 looks for help on topicname and displays any Examples sections
    found in the Results window. Alternatively, examples8 looks for help on
    function() (note the parentheses) and displays a definition in the
    Results window. It is especially designed to show quick and easy
    reminders of the syntax of a given command.

    wexamples is identical except that output appears in the Viewer.


Remarks

    examples8 is a renaming of the original version of examples, which is
    otherwise unchanged. examples8 should work in Stata 8 or 9. As from July
    2007, examples downloaded from SSC should work in Stata 10 upwards,
    modulo unforeseeable changes in syntax.

    Given a topicname, examples8 looks for sections starting with titles
    specified in SMCL containing the word Examples (or alternatively Example)
    within any help file corresponding to topicname. It will not be able to
    show material from older, pre-SMCL help files or examples given
    otherwise.


Examples

    . examples8 regress
    . examples8 reg

    . examples8 normden()


Author

    Nicholas J. Cox, Durham University U.K.
    n.j.cox@durham.ac.uk


Acknowledgments

    Ken Higbee gave valuable help on aliases. Clive Nicholas pointed towards
    a bug. Roger Harbord identified a bug and fixed it. Dick Campbell pointed
    out that examples (as was) was broken by Stata 10.


Also see

    On-line:  help for help; smcl