(latex2man.info)Translation of User Defined Macros

---

Next: Verbatim Environment Prev: Conditional Text Up: Top

---

Enter node , (file) or (file)node

Translation of User Defined Macros
----------------------------------

The user macro translation file (given by the [ -tTRANSFILE ]) contains
Perl commands specifying the translation of LaTeX macros defined by the
user. These macros may have none, one or two arguments. The following
code is expected:

   * Comments start with a # up to the end of the line.

   * For a macro \foo with no arguments, the following code must be
     specified:
    `Translation to Man-Pages'
          $manMacro{'foo'} = '...';

    `Translation to HTML'
          $htmlMacro{'foo'} = '...';

    `Translation to TexInfo'
          $texiMacro{'foo'} = '...';

     where ... is the translation.

   * For a macro \foo{..} with one argument, the following code must be
     specified:
    `Translation to Man-Pages'
          $manMacro1a{'foo'} = '...';
          $manMacro1b{'foo'} = '...';

    `Translation to HTML'
          $htmlMacro1a{'foo'} = '...';
          $htmlMacro1b{'foo'} = '...';

    `Translation to TexInfo'
          $texiMacro1a{'foo'} = '...';
          $texiMacro1b{'foo'} = '...';

     where ... is the translation. The 1a code is used before the
     argument, while 1b is typeset after the argument is set.

   * For a macro \foo{..}{..} with two arguments, the following code
     must be specified:
    `Translation to Man-Pages'
          $manMacro2a{'foo'} = '...';
          $manMacro2b{'foo'} = '...';
          $manMacro2c{'foo'} = '...';

    `Translation to HTML'
          $htmlMacro2a{'foo'} = '...';
          $htmlMacro2b{'foo'} = '...';
          $htmlMacro2c{'foo'} = '...';

    `Translation to TexInfo'
          $texiMacro2a{'foo'} = '...';
          $texiMacro2b{'foo'} = '...';
          $texiMacro2c{'foo'} = '...';

     where ... is the translation. The 2a code is used before the first
     argument, 2b between the two arguments and 2c is typeset after the
     second argument is set.

   * The file `latex2man.trans' contains some example code.