---
name: "Pod::Tree::PerlFunc"
section: "3pm"
platform: "linux"
package: "libpod-tree-perl"
version: "1.31-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Pod::Tree::PerlFunc"
---

# Pod::Tree::PerlFunc(3pm)

translate perlfunc.pod to HTML

## NAME

Pod::Tree::PerlFunc - translate perlfunc.pod to HTML

## SYNOPSIS

```
  $perl_map  = Pod::Tree::PerlMap->new;
  $perl_func = Pod::Tree::PerlFunc->new($perl_dir, $HTML_dir, $perl_map, %opts);
  $perl_func->scan;
  $perl_func->index;
  $perl_func->translate;
```

## DESCRIPTION

`"Pod::Tree::PerlFunc"` translates *perlfunc.pod* to HTML. It creates a separate HTML page for each function description in *perlfunc.pod*. The pages for the individual descriptions are named after the function and written to a *func/* subdirectory. *perlfunc.html* is generated as an index to all the pages in  *func/*.

`"Pod::Tree::PerlFunc"` generates and uses an index of the functions  that it finds in *perlfunc.pod* to construct HTML links. Other modules can also use this index.

## METHODS

- *$perl\_func* = "new" "Pod::Tree::PerlFunc" *$perl\_dir*, *$HTML\_dir*, *$perl\_map*, *%options*

  Creates and returns a new `"Pod::Tree::PerlFunc"` object.

  *$perl\_dir* is the root of the Perl source tree.

  *$HTML\_dir* is the directory where HTML files will be written.

  *$perl\_map* maps function names to URLs.

  *%options* are passed through to `"Pod::Tree::HTML"`.

- *$perl\_func*-\>"scan"

  Reads *perlfunc.pod* and identifies all the functions in it. Each function that is identified is entered into *$perl\_map*.

- *$perl\_func*-\>"index"

  Generates a top-level index of all the functions.  The index is written to *HTML\_dir*`"/pod/perlfunc.html"`.

- *$perl\_func*-\>"translate"

  Translates each function found by `"scan"` to HTML. The HTML pages are written to *HTML\_dir*`"/pod/func/"`.

## LINKING

`"Pod::Tree::PerlFunc"` indexes every `"=item"` paragraph in  *perlfunc.html*. To link, for example, to the `"abs"` function, write

```
    L<func/abs>
```

## REQUIRES

```
    5.005;
    Pod::Tree;
    Pod::Tree::HTML;
    Pod::Tree::PerlUtil;
```

## EXPORTS

Nothing.

## SEE ALSO

`"Pod::Tree::HTML"`, `"Pod::Tree::PerlMap"`,

## AUTHOR

Steven McDougall, swmcd@world.std.com

## COPYRIGHT

Copyright (c) 2000 by Steven McDougall.  This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.