[Main topics] [Navigation]

Program documentation with syntax highlighting

(Content of this page replaces earlier never fineshed content about FM-8 peculiarities. See information about this abandouned topic for exampe here.)

Every programmer uses a special program editor to develop code. To avoid common errors in coding, these editors highlight various syntactical elements of a program or script: variables, constants, function-names, keywords etc.

Hence documenting a program or script should make use of these functions. My favourite method is this:

  1. Print the desired code snippet or the whole code to pdf.
  2. Import (part) of that pdf into FrameMaker (by reference).
  3. Describe the conents of this picture.


PDF of a sample documentation done in FrameMaker.

My tools

Program/text editor: EditPad Pro. It comes with a host of syntax definitions. There is also a tool to develop/modify syntax definitions.

Publishing: FrameMaker since version 4. See the various pages on this site.

[Main topics] [Navigation]
 URL:  Created: 2004-04-20  Updated:
© Docu+Design Daube, Zürich    
  Business of Docu + Design Daube Documentation issues Sharing information Klaus Daube's personal opinions Guests on this site Home of Docu + Design Daube To main page in this category To first page in series To previous page in series To next page in series To bottom of page To top of page Search this site Site map Mail to webmaster To bottom of page To top of page