<?xml version="1.0" encoding="ascii"?>
<!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>epydoc.markup.epytext.Element</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.markup-module.html">Package markup</a> ::
<a href="epydoc.markup.epytext-module.html">Module epytext</a> ::
Class Element
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="epydoc.markup.epytext.Element-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Element</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#Element">source code</a></span></p>
<p>A very simple DOM-like representation for parsed epytext documents.
Each epytext document is encoded as a tree whose nodes are <a
href="epydoc.markup.epytext.Element-class.html" class="link">Element</a>
objects, and whose leaves are <code>string</code>s. Each node is marked
by a <i>tag</i> and zero or more <i>attributes</i>. Each attribute is a
mapping from a string key to a string value.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tag</span>,
<span class="summary-sig-arg">*children</span>,
<span class="summary-sig-arg">**attribs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#Element.__init__">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___34-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for___init___34-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for___init___34" name="call_graph_for___init___34">
<area shape="rect" href="epydoc.markup.epytext.Element-class.html#__init__" title="__init__()" alt="" coords="377,370,473,402" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_index_terms" title="ParsedEpytextDocstring._index_terms()" alt="" coords="7,6,327,38" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_to_html" title="ParsedEpytextDocstring._to_html()" alt="" coords="24,62,309,94" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#split_fields" title="ParsedEpytextDocstring.split_fields()" alt="" coords="16,118,317,150" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#summary" title="ParsedEpytextDocstring.summary()" alt="" coords="23,174,311,206" />
<area shape="rect" href="epydoc.markup.epytext.Token-class.html#to_dom" title="Token.to_dom()" alt="" coords="95,230,239,262" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_list" title="_add_list()" alt="" coords="115,286,219,318" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_add_section" title="_add_section()" alt="" coords="100,342,233,374" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize" title="_colorize()" alt="" coords="115,398,219,430" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_colorize_link" title="_colorize_link()" alt="" coords="96,454,237,486" />
<area shape="rect" href="epydoc.markup.epytext-module.html#_raise_graphs" title="_raise_graphs()" alt="" coords="97,510,236,542" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse" title="parse()" alt="" coords="129,566,204,598" />
<area shape="rect" href="epydoc.markup.epytext-module.html#parse_as_para" title="parse_as_para()" alt="" coords="96,622,237,654" />
<area shape="rect" href="epydoc.markup.pyval_repr.PyvalColorizer-class.html#_output" title="pyval_repr.PyvalColorizer._output()" alt="" coords="20,678,313,710" />
<area shape="rect" href="epydoc.markup.pyval_repr.PyvalColorizer-class.html#colorize" title="pyval_repr.PyvalColorizer.colorize()" alt="" coords="19,734,315,766" />
</map>
<img src="call_graph_for___init___34.gif" alt='' usemap="#call_graph_for___init___34" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.epytext.Element-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return a string representation of this element, using XML notation.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#Element.__str__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__repr__"></a><span class="summary-sig-name">__repr__</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#Element.__repr__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>string</code></span>
</td><td class="summary">
<a name="tag"></a><span class="summary-name">tag</span><br />
A string tag indicating the type of this element.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>list</code> of (<code>string</code> or <code>Element</code>)</span>
</td><td class="summary">
<a name="children"></a><span class="summary-name">children</span><br />
A list of the children of this element.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>dict</code> from <code>string</code> to <code>string</code></span>
</td><td class="summary">
<a name="attribs"></a><span class="summary-name">attribs</span><br />
A dictionary mapping attribute names to attribute values for this
element.
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__str__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Informal representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#Element.__str__">source code</a></span>
</td>
</tr></table>
<p>Return a string representation of this element, using XML
notation.</p>
<dl class="fields">
</dl>
<div class="fields"> <p><strong>Bug:</strong>
Doesn't escape '<' or '&' or '>'.
</p>
</div></td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
<a href="epydoc-log.html">Generated by Epydoc
3.0.1 on Wed Jan 30 14:08:31 2008</a>
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-release
>
by-pkgid
>
399492edb08a5eee73f1953c5b5cf636
>
files
>
210
