Lecture overview
Keyboard shortcut: 'u'  Previous slide in this lecture
Keyboard shortcut: 'p'  Next slide in this lecture
Keyboard shortcut: 'n'  Lecture notes - all slides and notes together  Annotated slide
Keyboard shortcut: 't'  Alphabetic index  Help page about these notes  Course home    Slide 13 : 20

Example of the manual document style 

The manual style has been used to document the LAML software package via a tool, which extracts particular doc comments from a Scheme program
 

; Top level functions

(manual-section
  (section-title "Top level functions")
  (section-body  
     "The important top level functions are manual-page and manual-section.
      These are the most important functions from a manual writer's perspective."))

(manual-page   
  'manual-page
  (title "manual-page")
  (form '(manual-page id . elements))
  (description "Defines a manual entry.")
  (parameters
    (parameter  "id" "A symbol identifying the manual page")
    (parameter  "elements" "Zero, one or more title, form, pre-condition,
                           description, parameters, example, or misc elements")
  )
)

(manual-page   
 'manual-section
 (title "manual-section")
 (form '(manual-section . element))
 (description "Defines a new section of a manual.
               The only forms allowed within a manual section are manual-title
               and manual-body")
 (parameters
   (parameter  "elements" "a list of manual-title and manual-body forms")
 )
)

; End top level functions