<?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>flumotion.common.documentation</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">
<!-- 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>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package flumotion ::
<a href="flumotion.common-module.html">Package common</a> ::
Module documentation
</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>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module documentation</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.common.documentation-pysrc.html">source code</a></span></p>
<p>creating links to online/installed documentation. Integration with
online and installed documentation for messages.</p>
<hr />
<div class="fields"> <p><strong>Version:</strong>
$Rev: 6125 $
</p>
</div><!-- ==================== 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 href="flumotion.common.documentation-module.html#getMessageWebLink" class="summary-sig-name">getMessageWebLink</a>(<span class="summary-sig-arg">message</span>)</span><br />
Get the on-line documentation link target for this message, if any.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.documentation-pysrc.html#getMessageWebLink">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">string</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.documentation-module.html#getWebLink" class="summary-sig-name">getWebLink</a>(<span class="summary-sig-arg">section</span>,
<span class="summary-sig-arg">anchor</span>,
<span class="summary-sig-arg">version</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">projectURL</span>=<span class="summary-sig-default">None</span>)</span><br />
Get a documentation link based on the parameters.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.documentation-pysrc.html#getWebLink">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="messageAddPythonInstall"></a><span class="summary-sig-name">messageAddPythonInstall</span>(<span class="summary-sig-arg">message</span>,
<span class="summary-sig-arg">moduleName</span>)</span><br />
Add text and link on how to install the given python module to the
given message.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.documentation-pysrc.html#messageAddPythonInstall">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="messageAddFixBadPermissions"></a><span class="summary-sig-name">messageAddFixBadPermissions</span>(<span class="summary-sig-arg">message</span>)</span><br />
Add link on how to change device permissions on Linux.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.documentation-pysrc.html#messageAddFixBadPermissions">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="messageAddGStreamerInstall"></a><span class="summary-sig-name">messageAddGStreamerInstall</span>(<span class="summary-sig-arg">message</span>)</span><br />
Add text and link on how to install the given python module to the
given message.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.documentation-pysrc.html#messageAddGStreamerInstall">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="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code><br />
hash(x)
</td>
</tr>
</table>
<!-- ==================== 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="getMessageWebLink"></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">getMessageWebLink</span>(<span class="sig-arg">message</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.documentation-pysrc.html#getMessageWebLink">source code</a></span>
</td>
</tr></table>
<p>Get the on-line documentation link target for this message, if
any.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>message</code></strong> (<a href="flumotion.common.messages.Message-class.html"
class="link">flumotion.common.messages.Message</a>) - the message</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getWebLink"></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">getWebLink</span>(<span class="sig-arg">section</span>,
<span class="sig-arg">anchor</span>,
<span class="sig-arg">version</span>=<span class="sig-default">None</span>,
<span class="sig-arg">projectURL</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.documentation-pysrc.html#getWebLink">source code</a></span>
</td>
</tr></table>
<p>Get a documentation link based on the parameters.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>section</code></strong> (string) - section, usually the name of the html file</li>
<li><strong class="pname"><code>anchor</code></strong> (string) - name of the anchor, part of a section</li>
<li><strong class="pname"><code>version</code></strong> (string @param projectURL, url for the project this link belongs
to.) - optional, version to use. If this is not specified the version
from configure.version will be used</li>
<li><strong class="pname"><code>projectURL</code></strong> (string)</li>
</ul></dd>
<dt>Returns: string</dt>
<dd>the constructed documentation link</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">
<!-- 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>
<th class="navbar" width="100%"></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 Sun Sep 13 13:13:55 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>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
contrib-release
>
by-pkgid
>
2eca861f24be6048290ed27335ec22aa
>
files
>
239
