diff options
Diffstat (limited to 'translate-toolkit-1.5.1/translate/doc/api/translate.storage.xml_extract.extract-module.html')
| -rw-r--r-- | translate-toolkit-1.5.1/translate/doc/api/translate.storage.xml_extract.extract-module.html | 810 |
1 files changed, 810 insertions, 0 deletions
diff --git a/translate-toolkit-1.5.1/translate/doc/api/translate.storage.xml_extract.extract-module.html b/translate-toolkit-1.5.1/translate/doc/api/translate.storage.xml_extract.extract-module.html new file mode 100644 index 0000000..2ebabbb --- /dev/null +++ b/translate-toolkit-1.5.1/translate/doc/api/translate.storage.xml_extract.extract-module.html @@ -0,0 +1,810 @@ +<?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>translate.storage.xml_extract.extract</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="translate-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://translate.sourceforge.net/wiki/toolkit/index">Translate Toolkit</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="translate-module.html">Package translate</a> :: + <a href="translate.storage-module.html">Package storage</a> :: + <a href="translate.storage.xml_extract-module.html">Package xml_extract</a> :: + Module extract + </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="translate.storage.xml_extract.extract-module.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== MODULE DESCRIPTION ==================== --> +<h1 class="epydoc">Module extract</h1><p class="nomargin-top"><span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html">source code</a></span></p> +<!-- ==================== CLASSES ==================== --> +<a name="section-Classes"></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">Classes</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Classes" + 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"> + <a href="translate.storage.xml_extract.extract.Translatable-class.html" class="summary-name">Translatable</a><br /> + A node corresponds to a translatable element. + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <a href="translate.storage.xml_extract.extract.ParseState-class.html" class="summary-name">ParseState</a><br /> + Maintain constants and variables used during the walking of a DOM + tree (via the function apply). + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <a href="translate.storage.xml_extract.extract.IdMaker-class.html" class="summary-name">IdMaker</a> + </td> + </tr> +</table> +<!-- ==================== FUNCTIONS ==================== --> +<a name="section-Functions"></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">Functions</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Functions" + 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="Nullable"></a><span class="summary-sig-name">Nullable</span>(<span class="summary-sig-arg">t</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#Nullable">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 href="translate.storage.xml_extract.extract-module.html#reduce_unit_tree" class="summary-sig-name">reduce_unit_tree</a>(<span class="summary-sig-arg">f</span>, + <span class="summary-sig-arg">unit_node</span>, + <span class="summary-sig-arg">*state</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#reduce_unit_tree">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr class="private"> + <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="translate.storage.xml_extract.extract-module.html#_process_placeable" class="summary-sig-name" onclick="show_private();">_process_placeable</a>(<span class="summary-sig-arg">dom_node</span>, + <span class="summary-sig-arg">state</span>)</span><br /> + Run find_translatable_dom_nodes on the current dom_node</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_process_placeable">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr class="private"> + <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="translate.storage.xml_extract.extract-module.html#_process_placeables" class="summary-sig-name" onclick="show_private();">_process_placeables</a>(<span class="summary-sig-arg">dom_node</span>, + <span class="summary-sig-arg">state</span>)</span><br /> + Return a list of placeables and list with alternating + string-placeable objects.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_process_placeables">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr class="private"> + <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="translate.storage.xml_extract.extract-module.html#_process_translatable" class="summary-sig-name" onclick="show_private();">_process_translatable</a>(<span class="summary-sig-arg">dom_node</span>, + <span class="summary-sig-arg">state</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_process_translatable">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr class="private"> + <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="translate.storage.xml_extract.extract-module.html#_process_children" class="summary-sig-name" onclick="show_private();">_process_children</a>(<span class="summary-sig-arg">dom_node</span>, + <span class="summary-sig-arg">state</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_process_children">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="compact_tag"></a><span class="summary-sig-name">compact_tag</span>(<span class="summary-sig-arg">nsmap</span>, + <span class="summary-sig-arg">namespace</span>, + <span class="summary-sig-arg">tag</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#compact_tag">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 href="translate.storage.xml_extract.extract-module.html#find_translatable_dom_nodes" class="summary-sig-name">find_translatable_dom_nodes</a>(<span class="summary-sig-arg">dom_node</span>, + <span class="summary-sig-arg">state</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#find_translatable_dom_nodes">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr class="private"> + <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="translate.storage.xml_extract.extract-module.html#_to_placeables" class="summary-sig-name" onclick="show_private();">_to_placeables</a>(<span class="summary-sig-arg">parent_translatable</span>, + <span class="summary-sig-arg">translatable</span>, + <span class="summary-sig-arg">id_maker</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_to_placeables">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr class="private"> + <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="translate.storage.xml_extract.extract-module.html#_add_translatable_to_store" class="summary-sig-name" onclick="show_private();">_add_translatable_to_store</a>(<span class="summary-sig-arg">store</span>, + <span class="summary-sig-arg">parent_translatable</span>, + <span class="summary-sig-arg">translatable</span>, + <span class="summary-sig-arg">id_maker</span>)</span><br /> + Construct a new translation unit, set its source and location + information and add it to 'store'.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_add_translatable_to_store">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr class="private"> + <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="translate.storage.xml_extract.extract-module.html#_contains_translatable_text" class="summary-sig-name" onclick="show_private();">_contains_translatable_text</a>(<span class="summary-sig-arg">translatable</span>)</span><br /> + Checks whether translatable contains any chunks of text which contain + more than whitespace.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_contains_translatable_text">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr class="private"> + <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="translate.storage.xml_extract.extract-module.html#_make_store_adder" class="summary-sig-name" onclick="show_private();">_make_store_adder</a>(<span class="summary-sig-arg">store</span>)</span><br /> + Return a function which, when called with a Translatable will add a + unit to 'store'.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_make_store_adder">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr class="private"> + <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="translate.storage.xml_extract.extract-module.html#_walk_translatable_tree" class="summary-sig-name" onclick="show_private();">_walk_translatable_tree</a>(<span class="summary-sig-arg">translatables</span>, + <span class="summary-sig-arg">f</span>, + <span class="summary-sig-arg">parent_translatable</span>, + <span class="summary-sig-arg">rid</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_walk_translatable_tree">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="reverse_map"></a><span class="summary-sig-name">reverse_map</span>(<span class="summary-sig-arg">a_map</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#reverse_map">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 href="translate.storage.xml_extract.extract-module.html#build_store" class="summary-sig-name">build_store</a>(<span class="summary-sig-arg">odf_file</span>, + <span class="summary-sig-arg">store</span>, + <span class="summary-sig-arg">parse_state</span>, + <span class="summary-sig-arg">store_adder</span>=<span class="summary-sig-default">None</span>)</span><br /> + Utility function for loading xml_filename</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#build_store">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +</table> +<!-- ==================== VARIABLES ==================== --> +<a name="section-Variables"></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">Variables</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Variables" + 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"> + <a name="TranslatableClass"></a><span class="summary-name">TranslatableClass</span> = <code title="Class('Translatable')">Class('Translatable')</code> + </td> + </tr> +</table> +<p class="indent-wrapped-lines"><b>Imports:</b> + <span title="lxml.etree">etree</span>, + <a href="translate.storage.base-module.html" title="translate.storage.base">base</a>, + <a href="translate.misc.typecheck-module.html#_null_decorator" title="translate.misc.typecheck.accepts">accepts</a>, + <a href="translate.misc.typecheck-module.html#Self" title="translate.misc.typecheck.Self">Self</a>, + <a href="translate.misc.typecheck.IsCallable-class.html" title="translate.misc.typecheck.IsCallable">IsCallable</a>, + <a href="translate.misc.typecheck.Or-class.html" title="translate.misc.typecheck.IsOneOf">IsOneOf</a>, + <a href="translate.misc.typecheck.Any-class.html" title="translate.misc.typecheck.Any">Any</a>, + <a href="translate.misc.typecheck.Class-class.html" title="translate.misc.typecheck.Class">Class</a>, + <span title="translate.misc.typecheck.typeclasses.Number">Number</span>, + <a href="translate.misc.contextlib-module.html#contextmanager" title="translate.misc.contextlib.contextmanager">contextmanager</a>, + <a href="translate.misc.contextlib-module.html#nested" title="translate.misc.contextlib.nested">nested</a>, + <a href="translate.misc.context-module.html#with_" title="translate.misc.context.with_">with_</a>, + <a href="translate.storage.xml_extract.xpath_breadcrumb-module.html" title="translate.storage.xml_extract.xpath_breadcrumb">xpath_breadcrumb</a>, + <a href="translate.storage.xml_extract.misc-module.html" title="translate.storage.xml_extract.misc">misc</a>, + <a href="translate.storage.placeables.xliff-module.html" title="translate.storage.placeables.xliff">xliff</a>, + <a href="translate.storage.placeables.strelem.StringElem-class.html" title="translate.storage.placeables.StringElem">StringElem</a> +</p><br /> +<!-- ==================== FUNCTION DETAILS ==================== --> +<a name="section-FunctionDetails"></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">Function Details</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-FunctionDetails" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +</table> +<a name="reduce_unit_tree"></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">reduce_unit_tree</span>(<span class="sig-arg">f</span>, + <span class="sig-arg">unit_node</span>, + <span class="sig-arg">*state</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#reduce_unit_tree">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@accepts(IsCallable(), Translatable, state= [Any()])</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="_process_placeable"></a> +<div class="private"> +<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">_process_placeable</span>(<span class="sig-arg">dom_node</span>, + <span class="sig-arg">state</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_process_placeable">source code</a></span> + </td> + </tr></table> + + <p>Run find_translatable_dom_nodes on the current dom_node</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@accepts(etree._Element, ParseState)</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="_process_placeables"></a> +<div class="private"> +<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">_process_placeables</span>(<span class="sig-arg">dom_node</span>, + <span class="sig-arg">state</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_process_placeables">source code</a></span> + </td> + </tr></table> + + <p>Return a list of placeables and list with alternating string-placeable + objects. The former is useful for directly working with placeables and + the latter is what will be used to build the final translatable + string.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@accepts(etree._Element, ParseState)</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="_process_translatable"></a> +<div class="private"> +<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">_process_translatable</span>(<span class="sig-arg">dom_node</span>, + <span class="sig-arg">state</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_process_translatable">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@accepts(etree._Element, ParseState)</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="_process_children"></a> +<div class="private"> +<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">_process_children</span>(<span class="sig-arg">dom_node</span>, + <span class="sig-arg">state</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_process_children">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@accepts(etree._Element, ParseState)</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="find_translatable_dom_nodes"></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">find_translatable_dom_nodes</span>(<span class="sig-arg">dom_node</span>, + <span class="sig-arg">state</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#find_translatable_dom_nodes">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@accepts(etree._Element, ParseState)</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="_to_placeables"></a> +<div class="private"> +<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">_to_placeables</span>(<span class="sig-arg">parent_translatable</span>, + <span class="sig-arg">translatable</span>, + <span class="sig-arg">id_maker</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_to_placeables">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@accepts(Nullable(Translatable), Translatable, IdMaker)</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="_add_translatable_to_store"></a> +<div class="private"> +<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">_add_translatable_to_store</span>(<span class="sig-arg">store</span>, + <span class="sig-arg">parent_translatable</span>, + <span class="sig-arg">translatable</span>, + <span class="sig-arg">id_maker</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_add_translatable_to_store">source code</a></span> + </td> + </tr></table> + + <p>Construct a new translation unit, set its source and location + information and add it to 'store'.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@accepts(base.TranslationStore, Nullable(Translatable), Translatable, IdMaker)</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="_contains_translatable_text"></a> +<div class="private"> +<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">_contains_translatable_text</span>(<span class="sig-arg">translatable</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_contains_translatable_text">source code</a></span> + </td> + </tr></table> + + <p>Checks whether translatable contains any chunks of text which contain + more than whitespace.</p> + <p>If not, then there's nothing to translate.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@accepts(Translatable)</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="_make_store_adder"></a> +<div class="private"> +<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">_make_store_adder</span>(<span class="sig-arg">store</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_make_store_adder">source code</a></span> + </td> + </tr></table> + + <p>Return a function which, when called with a Translatable will add a + unit to 'store'. The placeables will represented as strings according to + 'placeable_quoter'.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@accepts(base.TranslationStore)</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="_walk_translatable_tree"></a> +<div class="private"> +<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">_walk_translatable_tree</span>(<span class="sig-arg">translatables</span>, + <span class="sig-arg">f</span>, + <span class="sig-arg">parent_translatable</span>, + <span class="sig-arg">rid</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#_walk_translatable_tree">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@accepts([Translatable], IsCallable(), Nullable(Translatable), Number)</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="build_store"></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">build_store</span>(<span class="sig-arg">odf_file</span>, + <span class="sig-arg">store</span>, + <span class="sig-arg">parse_state</span>, + <span class="sig-arg">store_adder</span>=<span class="sig-default">None</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.storage.xml_extract.extract-pysrc.html#build_store">source code</a></span> + </td> + </tr></table> + + <p>Utility function for loading xml_filename</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@accepts(lambda obj: hasattr(obj, "read"), base.TranslationStore, ParseState, Nullable(IsCallable()))</code></li> + </ul></dd> + </dl> +</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="translate-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://translate.sourceforge.net/wiki/toolkit/index">Translate Toolkit</a></th> + </tr></table></th> + </tr> +</table> +<table border="0" cellpadding="0" cellspacing="0" width="100%%"> + <tr> + <td align="left" class="footer"> + Generated by Epydoc 3.0.1 on Wed Nov 25 17:17:01 2009 + </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> |