Changeset 696

Show
Ignore:
Timestamp:
09/07/10 20:48:50 (21 months ago)
Author:
mgalloy
Message:

Still adding to reference guide.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/reference/idldoc-reference.rst

    r695 r696  
    1 IDLdoc 3.3 Reference 
    2 ==================== 
     1IDLdoc 3.3 Reference Guide 
     2========================== 
    33 
    44:Author: Michael Galloy 
    … …  
    77 
    88 
    9 IDLdoc installation 
     9Installation 
    1010------------------- 
    1111 
    12 To install IDLdoc, simply unzip and place the IDLdoc distribution in your IDL path. Do not separate the contents of the distribution; the code looks for files in locations relative to itself. 
    13  
    14  
    15 IDLdoc routine keywords 
    16 ----------------------- 
     12To install IDLdoc, simply unzip and place the IDLdoc `.sav` file, or the `src/` directory if you are installing the IDLdoc source distribution, in your IDL path. 
     13 
     14Do not separate the contents of the distribution; the code looks for files in locations relative to itself. 
     15 
     16 
     17`IDLDOC` routine keywords 
     18------------------------- 
    1719 
    1820There are quite a few keywords to IDLdoc to set various specifications for the output. Also see the "Customizing Output" section for using templates for customized output. 
    … …  
    7678------------- 
    7779 
     80TODO: what is a format style? legacy format styles "IDLdoc", "IDL"; not recommended for new comments 
     81 
    7882 
    7983rst format style 
    … …  
    575579TODO: describe rst markup style 
    576580 
     581#. links, both kinds 
     582#. code blocks 
     583#. headers 
     584#. image directive 
     585#. embed directive 
     586#. title directive 
     587 
    577588verbatim markup style 
    578589~~~~~~~~~~~~~~~~~~~~~ 
    … …  
    594605Instead of modifying the existing templates, it is best to copy the templates and specify their location with the `TEMPLATE_LOCATION` keyword to `IDLDOC`. If you have multiple template families, the `TEMPLATE_PREFIX` keyword can be used to specify a string that prefixes each filename of the template family. For example, IDLdoc itself uses the "latex-" prefix to specify the templates used to produce LaTeX output. 
    595606 
    596 If IDLdoc is intended to produce some type of output besides HTML, the `COMMENT_STYLE` keyword must be used to specify the engine to produce that type of output. For example, IDLdoc provides the "latex" comment style to produce LaTeX output. Creating new comment style engines is beyond the scope of this reference guide. 
     607If IDLdoc is intended to produce some type of output besides HTML, the `COMMENT_STYLE` keyword must be used to specify the engine to produce that type of output. IDLdoc provides the "html", "latex", and "rst" comment styles. Creating new comment style engines is beyond the scope of this reference guide.