<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>
EtText: Documentation: Text::EtText::LinkGlossary
</title>
<meta name="generator" content="WebMake/2.2" />
<style>
body {
background-color: #ffffff;
color: #000000;
font-size: medium;
font-family: verdana,lucida,helvetica,sans-serif;
}
// OL,UL,P,BODY,TD,TR,TH,FORM {
// font-family: verdana,lucida,helvetica,sans-serif;
// font-size: medium;
// color: #000000;
}
code, samp, pre
{
font-family: monospace;
}
H1 { font-size: large; font-family: Garamond,Book Antiqua,Times,serif; }
H2 { font-size: large; font-family: Garamond,Book Antiqua,Times,serif; }
H3 { font-size: medium; font-family: Garamond,Book Antiqua,Times,serif; }
H4 { font-size: small; font-family: Garamond,Book Antiqua,Times,serif; }
H5 { font-size: x-small; font-family: Garamond,Book Antiqua,Times,serif; }
H6 { font-size: xx-small; font-family: Garamond,Book Antiqua,Times,serif; }
A:link {
font-weight: bold;
color: #004000;
text-decoration: underline;
}
A:visited {
font-weight: normal;
color: #008000;
text-decoration: underline;
}
A:active {
font-weight: bold;
color: #800000;
text-decoration: underline;
}
</style>
</head>
<body bgcolor="#ffffff" text="#000000" link="#3300cc" vlink="#660066">
<font face="lucida,verdana,sans-serif">
<div align="center">
<img src="images/EtTextTitle.png" width="489" height="113" />
</div>
<table width="100%">
<tr>
<td valign="top">
<strong><a href="http://ettext.taint.org/">EtText</a>
Documentation</strong> (version 2.2)
</td>
<td valign="top">
<div align="right">
[ <a href="HTML2EtText.pm.html">Back</a> | <a href="ethtml2text.html">Forward</a> | <a href="index.html">Index</a>
| <a href="allinone.html">All In One</a> ]
</div>
</td>
</tr>
</table>
<!-- yes, it's that Mozilla black-border code again ;) -->
<!-- stolen from www.mozilla.org via rc3.org -->
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td bgcolor="#aaaaaa">
<table border="0" cellspacing="4" cellpadding="4" width="100%">
<tr>
<td bgcolor="#ffffff">
<table border="0" cellspacing="4" cellpadding="4" width="100%">
<tr>
<td>
<h2>Text::EtText::LinkGlossary</h2><!-- INDEX BEGIN -->
<ul>
<li>
<a href="#NAME">NAME</a><li>
<a href="#SYNOPSIS">SYNOPSIS</a><li>
<a href="#DESCRIPTION">DESCRIPTION</a><li>
<a href="#METHODS">METHODS</a>
</ul>
<!-- INDEX END -->
<hr />
<h1><a name="NAME">NAME</a></h1><p>
Text::EtText::LinkGlossary - interface for EtText link glossaries to
implement.
<hr />
<h1><a name="SYNOPSIS">SYNOPSIS</a></h1><p>
<pre>
use Text::EtText::LinkGlossary;
</pre>
<p>
<pre>
@ISA = qw(Text::EtText::LinkGlossary);
</pre>
<p>
<pre>
sub open { ... }
sub close { ... }
...
</pre>
<hr />
<h1><a name="DESCRIPTION">DESCRIPTION</a></h1><p>
The <code>Text::EtText::LinkGlossary</code> is an interface which allows EtText to support ''link glossaries'',
persistent collections of link text and its corresponding HREF.
<p>
The interface which needs to be implemented is as follows:
<hr />
<h1><a name="METHODS">METHODS</a></h1><dl>
<dt>
<strong><a name="item__g_open_">$g->open()</a></strong>
</dt>
<dd>
<p>
Open the link glossary <code>$g</code> for reading and writing.
</dd>
<dt>
<strong><a name="item__g_close_">$g->close()</a></strong>
</dt>
<dd>
<p>
Close the link glossary; no more links can be written or read.
</dd>
<dt>
<strong><a name="item__url">$url = $g->get_link ($name)</a></strong>
</dt>
<dd>
<p>
Get a named link from the glossary.
</dd>
<dt>
<strong><a name="item__g_put_link">$g->put_link ($name, $url)</a></strong>
</dt>
<dd>
<p>
Put a named link to the glossary.
</dd>
<dt>
<strong>$url = $g->get_auto_link ($name)</strong>
</dt>
<dd>
<p>
Get a named automatic link from the glossary.
</dd>
<dt>
<strong><a name="item__g_put_auto_link">$g->put_auto_link ($name, $url)</a></strong>
</dt>
<dd>
<p>
Put a named automatic link to the glossary.
</dd>
<dt>
<strong><a name="item__keys">@keys = $g->get_auto_link_keys ()</a></strong>
</dt>
<dd>
<p>
Get a list of the names of automatic links stored in the glossary.
</dd>
<dt>
<strong><a name="item__g_add_auto_link_keys">$g->add_auto_link_keys (@keys)</a></strong>
</dt>
<dd>
<p>
Add to the list of names of automatic links stored in the glossary.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
</tr>
</table>
<table width="100%">
<tr>
<td valign="top">
<strong><a href="http://ettext.taint.org/">EtText</a>
Documentation</strong> (version 2.2)
</td>
<td valign="top">
<div align="right">
[ <a href="HTML2EtText.pm.html">Back</a> | <a href="ethtml2text.html">Forward</a> | <a href="index.html">Index</a>
| <a href="allinone.html">All In One</a> ]
</div>
</td>
</tr>
</table>
<div align="right">
<a href="http://webmake.taint.org/"><img src="images/BuiltWithWebMake.png" border="0" width="88" height="31" /></a>
</div>
</font>
</body>
</html>