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,2009 Fluendo, S.L. 
  6  # Copyright (C) 2010,2011 Flumotion Services, S.A. 
  7  # All rights reserved. 
  8  # 
  9  # This file may be distributed and/or modified under the terms of 
 10  # the GNU Lesser General Public License version 2.1 as published by 
 11  # the Free Software Foundation. 
 12  # This file is distributed without any warranty; without even the implied 
 13  # warranty of merchantability or fitness for a particular purpose. 
 14  # See "LICENSE.LGPL" in the source distribution for more information. 
 15  # 
 16  # Headers in this file shall remain intact. 
 17   
 18  """creating links to online/installed documentation. 
 19  Integration with online and installed documentation for messages. 
 20  """ 
 21   
 22  __version__ = "$Rev: 6125 $" 
 23   
 24  from flumotion.common import common, errors 
 25  from flumotion.common.i18n import getLL 
 26  from flumotion.configure import configure 
 27   
 28  from flumotion.common.i18n import N_, gettexter 
 29   
 30  T_ = gettexter() 
 31   
 32   
 53   
 54   
 86   
 87   
88 -def messageAddPythonInstall(message, moduleName):
89 """ 90 Add text and link on how to install the given python module to the 91 given message. 92 """ 93 message.add(T_(N_("Please install the '%s' python module."), moduleName)) 94 message.description = T_(N_("Learn how to install Python modules.")) 95 message.section = 'appendix-installing-dependencies' 96 message.anchor = 'section-installing-python-modules'
97 98
99 -def messageAddFixBadPermissions(message):
100 """ 101 Add link on how to change device permissions on Linux. 102 """ 103 message.description = T_(N_("Learn how to change device permissions.")) 104 message.section = 'section-flumotion-troubleshoot' 105 message.anchor = 'section-not-open'
106 107
108 -def messageAddGStreamerInstall(message):
109 """ 110 Add text and link on how to install the given python module to the 111 given message. 112 """ 113 message.description = T_(N_('Learn how to install GStreamer elements.')) 114 message.section = 'section-installing-gstreamer-plugins'
115