Package flumotion :: Package common :: Module documentation
[hide private]

Source Code for Module flumotion.common.documentation

  1  # -*- Mode: Python -*- 
  2  # vi:si:et:sw=4:sts=4:ts=4 
  3  # 
  4  # Flumotion - a streaming media server 
  5  # Copyright (C) 2004,2005,2006,2007,2008 Fluendo, S.L. (www.fluendo.com). 
  6  # All rights reserved. 
  7   
  8  # This file may be distributed and/or modified under the terms of 
  9  # the GNU General Public License version 2 as published by 
 10  # the Free Software Foundation. 
 11  # This file is distributed without any warranty; without even the implied 
 12  # warranty of merchantability or fitness for a particular purpose. 
 13  # See "LICENSE.GPL" in the source distribution for more information. 
 14   
 15  # Licensees having purchased or holding a valid Flumotion Advanced 
 16  # Streaming Server license may use this file in accordance with the 
 17  # Flumotion Advanced Streaming Server Commercial License Agreement. 
 18  # See "LICENSE.Flumotion" in the source distribution for more information. 
 19   
 20  # Headers in this file shall remain intact. 
 21   
 22  """creating links to online/installed documentation. 
 23  Integration with online and installed documentation for messages. 
 24  """ 
 25   
 26  __version__ = "$Rev: 6125 $" 
 27   
 28  from flumotion.common import common, errors 
 29  from flumotion.common.i18n import getLL 
 30  from flumotion.configure import configure 
 31   
 32  from flumotion.common.i18n import N_, gettexter 
 33   
 34  T_ = gettexter() 
 35   
 36   
 57   
 58   
 90   
 91   
92 -def messageAddPythonInstall(message, moduleName):
93 """ 94 Add text and link on how to install the given python module to the 95 given message. 96 """ 97 message.add(T_(N_("Please install the '%s' python module."), moduleName)) 98 message.description = T_(N_("Learn how to install Python modules.")) 99 message.section = 'appendix-installing-dependencies' 100 message.anchor = 'section-installing-python-modules'
101 102
103 -def messageAddFixBadPermissions(message):
104 """ 105 Add link on how to change device permissions on Linux. 106 """ 107 message.description = T_(N_("Learn how to change device permissions.")) 108 message.section = 'section-flumotion-troubleshoot' 109 message.anchor = 'section-not-open'
110 111
112 -def messageAddGStreamerInstall(message):
113 """ 114 Add text and link on how to install the given python module to the 115 given message. 116 """ 117 message.description = T_(N_('Learn how to install GStreamer elements.')) 118 message.section = 'section-installing-gstreamer-plugins'
119