1  # $Id: localizable-string.rb,v 1.14 2011/12/09 08:03:28 machan Exp $
   2 
   3  module TmDoc::Transformer::LocalizableString
   4      BOOK_TITLE  = 'TmDoc document'
   5 
   6 
   7      DIV_OVERVIEW            = 'Overview'
   8      DIV_UNKNOWN_M_AND_C     = 'Unknown Modules and Classes'
   9      DIV_BUILTIN_M_AND_C     = 'Built-in Modules and Classes'
  10      DIV_USER_M_AND_C        = 'User Defined Modules and Classes'
  11      DIV_SOURCES             = 'Sources'
  12 
  13      DIV_M_STRUCTURE         = 'Module Structure'
  14      DIV_C_HIERARCHY         = 'Class Hierarchy'
  15      DIV_S_STRUCTURE         = 'Source Structure'
  16      DIV_CODE                = 'Code'
  17 
  18      DIV_MODULE              = 'Module'
  19      DIV_CLASS               = 'Class'
  20      DIV_METHOD              = 'Method'
  21      DIV_FILE                = 'File'
  22 
  23      DIV_CONSTANTS           = 'Constants'
  24 
  25      DIV_MODULE_ALIASES      = 'Module Aliases'
  26      DIV_MODULE_ATTRIBUTES   = 'Module Attributes'
  27      DIV_MODULE_FUNCTIONS    = 'Module Functions'
  28      DIV_MODULE_METHODS      = 'Module Methods'
  29 
  30      DIV_CLASS_ALIASES       = 'Class Aliases'
  31      DIV_CLASS_ATTRIBUTES    = 'Class Attributes'
  32      DIV_CLASS_METHODS       = 'Class Methods'
  33 
  34      DIV_INSTANCE_ALIASES    = 'Instance Aliases'
  35      DIV_INSTANCE_ATTRIBUTES = 'Instance Attributes'
  36      DIV_INSTANCE_METHODS    = 'Instance Methods'
  37 
  38 
  39      FILE                = 'file'
  40      MODULE              = 'module'
  41      CLASS               = 'class'
  42      CONSTANT            = 'constant'
  43 
  44      ALIAS               = 'alias'
  45      MODULE_ALIAS        = 'module alias'
  46      CLASS_ALIAS         = 'class alias'
  47      INSTANCE_ALIAS      = 'instance alias'
  48 
  49      ATTRIBUTE           = 'attribute'
  50      MODULE_ATTRIBUTE    = 'module attribute'
  51      CLASS_ATTRIBUTE     = 'class attribute'
  52      INSTANCE_ATTRIBUTE  = 'instance attribute'
  53 
  54      FUNCTION            = 'function'
  55      METHOD              = 'method'
  56      MODULE_FUNCTION     = 'module function'
  57      MODULE_METHOD       = 'module method'
  58      CLASS_METHOD        = 'class method'
  59      INSTANCE_METHOD     = 'instance method'
  60 
  61 
  62      LAB_A_SUBMODULE_OF  = 'is a submodule of'
  63      LAB_SUBMODULES      = 'is modularized into'
  64      LAB_SIBLING_MODULES = 'has modular siblings'
  65      LAB_EXTENDEES       = 'extends'
  66      LAB_EXTENDERS       = 'is extended by'
  67      LAB_INCLUDEES       = 'includes'
  68      LAB_INCLUDERS       = 'is included by'
  69      LAB_SUPERCLASS      = 'inherits from'
  70      LAB_SUBCLASSES      = 'is inherited by'
  71      LAB_SIBLING_CLASSES = 'has class siblings'
  72      LAB_PROPERTIES      = 'has properties'
  73      LAB_LOCATIONS       = 'is defined at'
  74 
  75 
  76      TOPLEVEL_MODULE     = '<Toplevel Module>'
  77      BUILTIN_MODULE      = '<Built-in Module>'
  78      UNKNOWN_MODULE      = '<Unknown Module>'
  79      UNKNOWN_CLASS       = '<Unknown Class>'
  80 
  81 
  82 
  83      HASH_OF_TAG_TO_TITLE = {
  84          :constant           => DIV_CONSTANTS,
  85 
  86          :module_alias       => DIV_MODULE_ALIASES,
  87          :module_attribute   => DIV_MODULE_ATTRIBUTES,
  88          :module_function    => DIV_MODULE_FUNCTIONS,
  89          :module_method      => DIV_MODULE_METHODS,
  90 
  91          :class_alias        => DIV_CLASS_ALIASES,
  92          :class_attribute    => DIV_CLASS_ATTRIBUTES,
  93          :class_method       => DIV_CLASS_METHODS,
  94 
  95          :instance_alias     => DIV_INSTANCE_ALIASES,
  96          :instance_attribute => DIV_INSTANCE_ATTRIBUTES,
  97          :instance_method    => DIV_INSTANCE_METHODS
  98      }
  99 
 100      HASH_OF_TAG_TO_LABEL =  {
 101          :constant           => CONSTANT,
 102 
 103          :module_alias       => MODULE_ALIAS,
 104          :class_alias        => CLASS_ALIAS,
 105          :instance_alias     => ALIAS,
 106 
 107          :module_attribute   => MODULE_ATTRIBUTE,
 108          :class_attribute    => CLASS_ATTRIBUTE,
 109          :instance_attribute => ATTRIBUTE,
 110 
 111          :module_function    => FUNCTION,
 112          :module_method      => MODULE_METHOD,
 113          :class_method       => CLASS_METHOD,
 114          :instance_method    => METHOD
 115      }
 116  end