doc/xml2po-modes/gs.py

   1 # Copyright (c) 2004 Danilo Segan <danilo@kvota.net>.
   2 #
   3 # This file is part of xml2po.
   4 #
   5 # xml2po is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # xml2po is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with xml2po; if not, write to the Free Software Foundation, Inc.,
  17 # 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18 #
  19
  20 # Special case Gnome Summary
  21 #
  22
  23 class gsXmlMode:
  24     """Abstract class for special handling of document types."""
  25     def getIgnoredTags(self):
  26         "Returns array of tags to be ignored."
  27         return [ 'link', 'bug-stats', 'cvs-stats', 'unixname' ]
  28
  29     def getFinalTags(self):
  30         "Returns array of tags to be considered 'final'."
  31         return ['title', 'para', 'name', 'desc' ]
  32
  33     def getSpacePreserveTags(self):
  34         "Returns array of tags in which spaces are to be preserved."
  35         return []
  36
  37     def preProcessXml(self, doc, msg):
  38         "Preprocess a document and perhaps adds some messages."
  39         pass
  40
  41     def _find_salute(self, node):
  42         if node.name == 'salute':
  43             return node
  44         child = node.children
  45         while child:
  46             ret = self._find_salute(child)
  47             if ret:
  48                 return ret
  49             child = child.next
  50         return None
  51
  52     def postProcessXmlTranslation(self, doc, language, translators):
  53         """Sets a language and translators in "doc" tree.
  54
  55         "translators" is a string consisted of translator credits.
  56         "language" is a simple string.
  57         "doc" is a libxml2.xmlDoc instance."""
  58         # Find "salute" tag and add a comment about translator.
  59         if translators == self.getStringForTranslators():
  60             return
  61         else:
  62             salute = self._find_salute(doc.getRootElement())
  63             if salute and salute.name=='salute':
  64                 # found
  65                 salute.newChild(None, "para", translators)
  66             else:
  67                 return
  68
  69     def getStringForTranslators(self):
  70         """Returns None or a string to be added to PO files.
  71
  72         Common example is 'translator-credits'."""
  73         return "translator-credits"
  74
  75     def getCommentForTranslators(self):
  76         """Returns a comment to be added next to string for crediting translators.
  77
  78         It should explain the format of the string provided by getStringForTranslators()."""
  79         return """Translators: enter a short paragraph creditting yourself and others who helped you with the translation."""