Text::EtText::LinkGlossary

• NAME
• SYNOPSIS
• DESCRIPTION
• METHODS

NAME

Text::EtText::LinkGlossary - interface for EtText link glossaries to implement.

SYNOPSIS

  use Text::EtText::LinkGlossary;

  @ISA = qw(Text::EtText::LinkGlossary);

  sub open { ... }
  sub close { ... }
  ...

DESCRIPTION

The Text::EtText::LinkGlossary is an interface which allows EtText to support ''link glossaries'', persistent collections of link text and its corresponding HREF.

The interface which needs to be implemented is as follows:

METHODS

$g->open()

Open the link glossary $g for reading and writing.

$g->close()

Close the link glossary; no more links can be written or read.

$url = $g->get_link ($name)

Get a named link from the glossary.

$g->put_link ($name, $url)

Put a named link to the glossary.

$url = $g->get_auto_link ($name)

Get a named automatic link from the glossary.

$g->put_auto_link ($name, $url)

Put a named automatic link to the glossary.

@keys = $g->get_auto_link_keys ()

Get a list of the names of automatic links stored in the glossary.

$g->add_auto_link_keys (@keys)

Add to the list of names of automatic links stored in the glossary.