translator_en.h

/******************************************************************************
 *
 *
 *
 * Copyright (C) 1997-2015 by Dimitri van Heesch.
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby
 * granted. No representations are made about the suitability of this software
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
 *
 */

#ifndef TRANSLATOR_EN_H
#define TRANSLATOR_EN_H

class TranslatorEnglish : public Translator
{
  public:

    // --- Language control methods -------------------

    virtual QCString idLanguage()
    { return "english"; }

    virtual QCString latexLanguageSupportCommand()
    {
      return "";
    }

    // --- Language translation methods -------------------

    virtual QCString trRelatedFunctions()
    { return "Related Functions"; }

    virtual QCString trRelatedSubscript()
    { return "(Note that these are not member functions.)"; }

    virtual QCString trDetailedDescription()
    { return "Detailed Description"; }

    virtual QCString trMemberTypedefDocumentation()
    { return "Member Typedef Documentation"; }

    virtual QCString trMemberEnumerationDocumentation()
    { return "Member Enumeration Documentation"; }

    virtual QCString trMemberFunctionDocumentation()
    { return "Member Function Documentation"; }

    virtual QCString trMemberDataDocumentation()
    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Field Documentation";
      }
      else
      {
        return "Member Data Documentation";
      }
    }

    virtual QCString trMore()
    { return "More..."; }

    virtual QCString trListOfAllMembers()
    { return "List of all members"; }

    virtual QCString trMemberList()
    { return "Member List"; }

    virtual QCString trThisIsTheListOfAllMembers()
    { return "This is the complete list of members for "; }

    virtual QCString trIncludingInheritedMembers()
    { return ", including all inherited members."; }

    virtual QCString trGeneratedAutomatically(const char *s)
    { QCString result="Generated automatically by Doxygen";
      if (s) result+=(QCString)" for "+s;
      result+=" from the source code.";
      return result;
    }

    virtual QCString trEnumName()
    { return "enum name"; }

    virtual QCString trEnumValue()
    { return "enum value"; }

    virtual QCString trDefinedIn()
    { return "defined in"; }

    // quick reference sections

    virtual QCString trModules()
    { return "Modules"; }

    virtual QCString trClassHierarchy()
    { return "Class Hierarchy"; }

    virtual QCString trCompoundList()
    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Structures";
      }
      else
      {
        return "Class List";
      }
    }

    virtual QCString trFileList()
    { return "File List"; }

    virtual QCString trCompoundMembers()
    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Fields";
      }
      else
      {
        return "Class Members";
      }
    }

    virtual QCString trFileMembers()
    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Globals";
      }
      else
      {
        return "File Members";
      }
    }

    virtual QCString trRelatedPages()
    { return "Related Pages"; }

    virtual QCString trExamples()
    { return "Examples"; }

    virtual QCString trSearch()
    { return "Search"; }

    virtual QCString trClassHierarchyDescription()
    { return "This inheritance list is sorted roughly, "
             "but not completely, alphabetically:";
    }

    virtual QCString trFileListDescription(bool extractAll)
    {
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="files with brief descriptions:";
      return result;
    }

    virtual QCString trCompoundListDescription()
    {

      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Here are the data structures with brief descriptions:";
      }
      else
      {
        return "Here are the classes, structs, "
               "unions and interfaces with brief descriptions:";
      }
    }

    virtual QCString trCompoundMembersDescription(bool extractAll)
    {
      QCString result="Here is a list of all ";
      if (!extractAll)
      {
        result+="documented ";
      }
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        result+="struct and union fields";
      }
      else
      {
        result+="class members";
      }
      result+=" with links to ";
      if (!extractAll)
      {
        if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
        {
          result+="the struct/union documentation for each field:";
        }
        else
        {
          result+="the class documentation for each member:";
        }
      }
      else
      {
        if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
        {
          result+="the structures/unions they belong to:";
        }
        else
        {
          result+="the classes they belong to:";
        }
      }
      return result;
    }

    virtual QCString trFileMembersDescription(bool extractAll)
    {
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";

      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        result+="functions, variables, defines, enums, and typedefs";
      }
      else
      {
        result+="file members";
      }
      result+=" with links to ";
      if (extractAll)
        result+="the files they belong to:";
      else
        result+="the documentation:";
      return result;
    }

    virtual QCString trExamplesDescription()
    { return "Here is a list of all examples:"; }

    virtual QCString trRelatedPagesDescription()
    { return "Here is a list of all related documentation pages:"; }

    virtual QCString trModulesDescription()
    { return "Here is a list of all modules:"; }

    // index titles (the project name is prepended for these)

    virtual QCString trDocumentation()
    { return "Documentation"; }

    virtual QCString trModuleIndex()
    { return "Module Index"; }

    virtual QCString trHierarchicalIndex()
    { return "Hierarchical Index"; }

    virtual QCString trCompoundIndex()
    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Structure Index";
      }
      else
      {
        return "Class Index";
      }
    }

    virtual QCString trFileIndex()
    { return "File Index"; }

    virtual QCString trModuleDocumentation()
    { return "Module Documentation"; }

    virtual QCString trClassDocumentation()
    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Structure Documentation";
      }
      else
      {
        return "Class Documentation";
      }
    }

    virtual QCString trFileDocumentation()
    { return "File Documentation"; }

    virtual QCString trExampleDocumentation()
    { return "Example Documentation"; }

    virtual QCString trPageDocumentation()
    { return "Page Documentation"; }

    virtual QCString trReferenceManual()
    { return "Reference Manual"; }

    virtual QCString trDefines()
    { return "Macros"; }

    virtual QCString trTypedefs()
    { return "Typedefs"; }

    virtual QCString trEnumerations()
    { return "Enumerations"; }

    virtual QCString trFunctions()
    { return "Functions"; }

    virtual QCString trVariables()
    { return "Variables"; }

    virtual QCString trEnumerationValues()
    { return "Enumerator"; }

    virtual QCString trDefineDocumentation()
    { return "Macro Definition Documentation"; }

    virtual QCString trTypedefDocumentation()
    { return "Typedef Documentation"; }

    virtual QCString trEnumerationTypeDocumentation()
    { return "Enumeration Type Documentation"; }

    virtual QCString trFunctionDocumentation()
    { return "Function Documentation"; }

    virtual QCString trVariableDocumentation()
    { return "Variable Documentation"; }

    virtual QCString trCompounds()
    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Structures";
      }
      else
      {
        return "Classes";
      }
    }

    virtual QCString trGeneratedAt(const char *date,const char *projName)
    {
      QCString result=(QCString)"Generated on "+date;
      if (projName) result+=(QCString)" for "+projName;
      result+=(QCString)" by";
      return result;
    }

    virtual QCString trClassDiagram(const char *clName)
    {
      return (QCString)"Inheritance diagram for "+clName+":";
    }

    virtual QCString trForInternalUseOnly()
    { return "For internal use only."; }

    virtual QCString trWarning()
    { return "Warning"; }

    virtual QCString trVersion()
    { return "Version"; }

    virtual QCString trDate()
    { return "Date"; }

    virtual QCString trReturns()
    { return "Returns"; }

    virtual QCString trSeeAlso()
    { return "See also"; }

    virtual QCString trParameters()
    { return "Parameters"; }

    virtual QCString trExceptions()
    { return "Exceptions"; }

    virtual QCString trGeneratedBy()
    { return "Generated by"; }

// new since 0.49-990307

    virtual QCString trNamespaceList()
    { return "Namespace List"; }

    virtual QCString trNamespaceListDescription(bool extractAll)
    {
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="namespaces with brief descriptions:";
      return result;
    }

    virtual QCString trFriends()
    { return "Friends"; }

// new since 0.49-990405

    virtual QCString trRelatedFunctionDocumentation()
    { return "Friends And Related Function Documentation"; }

// new since 0.49-990425

    virtual QCString trCompoundReference(const char *clName,
                                    ClassDef::CompoundType compType,
                                    bool isTemplate)
    {
      QCString result=(QCString)clName;
      switch(compType)
      {
        case ClassDef::Class:      result+=" Class"; break;
        case ClassDef::Struct:     result+=" Struct"; break;
        case ClassDef::Union:      result+=" Union"; break;
        case ClassDef::Interface:  result+=" Interface"; break;
        case ClassDef::Protocol:   result+=" Protocol"; break;
        case ClassDef::Category:   result+=" Category"; break;
        case ClassDef::Exception:  result+=" Exception"; break;
        default: break;
      }
      if (isTemplate) result+=" Template";
      result+=" Reference";
      return result;
    }

    virtual QCString trFileReference(const char *fileName)
    {
      QCString result=fileName;
      result+=" File Reference";
      return result;
    }

    virtual QCString trNamespaceReference(const char *namespaceName)
    {
      QCString result=namespaceName;
      result+=" Namespace Reference";
      return result;
    }

    virtual QCString trPublicMembers()
    { return "Public Member Functions"; }
    virtual QCString trPublicSlots()
    { return "Public Slots"; }
    virtual QCString trSignals()
    { return "Signals"; }
    virtual QCString trStaticPublicMembers()
    { return "Static Public Member Functions"; }
    virtual QCString trProtectedMembers()
    { return "Protected Member Functions"; }
    virtual QCString trProtectedSlots()
    { return "Protected Slots"; }
    virtual QCString trStaticProtectedMembers()
    { return "Static Protected Member Functions"; }
    virtual QCString trPrivateMembers()
    { return "Private Member Functions"; }
    virtual QCString trPrivateSlots()
    { return "Private Slots"; }
    virtual QCString trStaticPrivateMembers()
    { return "Static Private Member Functions"; }

    virtual QCString trWriteList(int numEntries)
    {
      QCString result;
      int i;
      // the inherits list contain `numEntries' classes
      for (i=0;i<numEntries;i++)
      {
        // use generateMarker to generate placeholders for the class links!
        result+=generateMarker(i); // generate marker for entry i in the list
                                   // (order is left to right)

        if (i!=numEntries-1)  // not the last entry, so we need a separator
        {
          if (i<numEntries-2) // not the fore last entry
            result+=", ";
          else                // the fore last entry
            result+=", and ";
        }
      }
      return result;
    }

    virtual QCString trInheritsList(int numEntries)
    {
      return "Inherits "+trWriteList(numEntries)+".";
    }

    virtual QCString trInheritedByList(int numEntries)
    {
      return "Inherited by "+trWriteList(numEntries)+".";
    }

    virtual QCString trReimplementedFromList(int numEntries)
    {
      return "Reimplemented from "+trWriteList(numEntries)+".";
    }

    virtual QCString trReimplementedInList(int numEntries)
    {
      return "Reimplemented in "+trWriteList(numEntries)+".";
    }

    virtual QCString trNamespaceMembers()
    { return "Namespace Members"; }

    virtual QCString trNamespaceMemberDescription(bool extractAll)
    {
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="namespace members with links to ";
      if (extractAll)
        result+="the namespace documentation for each member:";
      else
        result+="the namespaces they belong to:";
      return result;
    }
    virtual QCString trNamespaceIndex()
    { return "Namespace Index"; }

    virtual QCString trNamespaceDocumentation()
    { return "Namespace Documentation"; }

// new since 0.49-990522

    virtual QCString trNamespaces()
    { return "Namespaces"; }

// new since 0.49-990728

    virtual QCString trGeneratedFromFiles(ClassDef::CompoundType compType,
        bool single)
    { // single is true implies a single file
      QCString result=(QCString)"The documentation for this ";
      switch(compType)
      {
        case ClassDef::Class:      result+="class"; break;
        case ClassDef::Struct:     result+="struct"; break;
        case ClassDef::Union:      result+="union"; break;
        case ClassDef::Interface:  result+="interface"; break;
        case ClassDef::Protocol:   result+="protocol"; break;
        case ClassDef::Category:   result+="category"; break;
        case ClassDef::Exception:  result+="exception"; break;
        default: break;
      }
      result+=" was generated from the following file";
      if (single) result+=":"; else result+="s:";
      return result;
    }

// new since 0.49-990901

    virtual QCString trReturnValues()
    { return "Return values"; }

    virtual QCString trMainPage()
    { return "Main Page"; }

    virtual QCString trPageAbbreviation()
    { return "p."; }

// new since 0.49-991003

    virtual QCString trDefinedAtLineInSourceFile()
    {
      return "Definition at line @0 of file @1.";
    }
    virtual QCString trDefinedInSourceFile()
    {
      return "Definition in file @0.";
    }

// new since 0.49-991205

    virtual QCString trDeprecated()
    {
      return "Deprecated";
    }

// new since 1.0.0

    virtual QCString trCollaborationDiagram(const char *clName)
    {
      return (QCString)"Collaboration diagram for "+clName+":";
    }
    virtual QCString trInclDepGraph(const char *fName)
    {
      return (QCString)"Include dependency graph for "+fName+":";
    }
    virtual QCString trConstructorDocumentation()
    {
      return "Constructor & Destructor Documentation";
    }
    virtual QCString trGotoSourceCode()
    {
      return "Go to the source code of this file.";
    }
    virtual QCString trGotoDocumentation()
    {
      return "Go to the documentation of this file.";
    }
    virtual QCString trPrecondition()
    {
      return "Precondition";
    }
    virtual QCString trPostcondition()
    {
      return "Postcondition";
    }
    virtual QCString trInvariant()
    {
      return "Invariant";
    }
    virtual QCString trInitialValue()
    {
      return "Initial value:";
    }
    virtual QCString trCode()
    {
      return "code";
    }
    virtual QCString trGraphicalHierarchy()
    {
      return "Graphical Class Hierarchy";
    }
    virtual QCString trGotoGraphicalHierarchy()
    {
      return "Go to the graphical class hierarchy";
    }
    virtual QCString trGotoTextualHierarchy()
    {
      return "Go to the textual class hierarchy";
    }
    virtual QCString trPageIndex()
    {
      return "Page Index";
    }

// new since 1.1.0

    virtual QCString trNote()
    {
      return "Note";
    }
    virtual QCString trPublicTypes()
    {
      return "Public Types";
    }
    virtual QCString trPublicAttribs()
    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Fields";
      }
      else
      {
        return "Public Attributes";
      }
    }
    virtual QCString trStaticPublicAttribs()
    {
      return "Static Public Attributes";
    }
    virtual QCString trProtectedTypes()
    {
      return "Protected Types";
    }
    virtual QCString trProtectedAttribs()
    {
      return "Protected Attributes";
    }
    virtual QCString trStaticProtectedAttribs()
    {
      return "Static Protected Attributes";
    }
    virtual QCString trPrivateTypes()
    {
      return "Private Types";
    }
    virtual QCString trPrivateAttribs()
    {
      return "Private Attributes";
    }
    virtual QCString trStaticPrivateAttribs()
    {
      return "Static Private Attributes";
    }

// new since 1.1.3

    virtual QCString trTodo()
    {
      return "Todo";
    }
    virtual QCString trTodoList()
    {
      return "Todo List";
    }

// new since 1.1.4

    virtual QCString trReferencedBy()
    {
      return "Referenced by";
    }
    virtual QCString trRemarks()
    {
      return "Remarks";
    }
    virtual QCString trAttention()
    {
      return "Attention";
    }
    virtual QCString trInclByDepGraph()
    {
      return "This graph shows which files directly or "
             "indirectly include this file:";
    }
    virtual QCString trSince()
    {
      return "Since";
    }

// new since 1.1.5

    virtual QCString trLegendTitle()
    {
      return "Graph Legend";
    }
    virtual QCString trLegendDocs()
    {
      return
        "This page explains how to interpret the graphs that are generated "
        "by doxygen.<p>\n"
        "Consider the following example:\n"
        "\\code\n"
        "/*! Invisible class because of truncation */\n"
        "class Invisible { };\n\n"
        "/*! Truncated class, inheritance relation is hidden */\n"
        "class Truncated : public Invisible { };\n\n"
        "/* Class not documented with doxygen comments */\n"
        "class Undocumented { };\n\n"
        "/*! Class that is inherited using public inheritance */\n"
        "class PublicBase : public Truncated { };\n\n"
        "/*! A template class */\n"
        "template<class T> class Templ { };\n\n"
        "/*! Class that is inherited using protected inheritance */\n"
        "class ProtectedBase { };\n\n"
        "/*! Class that is inherited using private inheritance */\n"
        "class PrivateBase { };\n\n"
        "/*! Class that is used by the Inherited class */\n"
        "class Used { };\n\n"
        "/*! Super class that inherits a number of other classes */\n"
        "class Inherited : public PublicBase,\n"
        "                  protected ProtectedBase,\n"
        "                  private PrivateBase,\n"
        "                  public Undocumented,\n"
        "                  public Templ<int>\n"
        "{\n"
        "  private:\n"
        "    Used *m_usedClass;\n"
        "};\n"
        "\\endcode\n"
        "This will result in the following graph:"
        "<p><center><img alt=\"\" src=\"graph_legend."+getDotImageExtension()+"\"></center></p>\n"
        "<p>\n"
        "The boxes in the above graph have the following meaning:\n"
        "</p>\n"
        "<ul>\n"
        "<li>%A filled gray box represents the struct or class for which the "
        "graph is generated.</li>\n"
        "<li>%A box with a black border denotes a documented struct or class.</li>\n"
        "<li>%A box with a gray border denotes an undocumented struct or class.</li>\n"
        "<li>%A box with a red border denotes a documented struct or class for"
        "which not all inheritance/containment relations are shown. %A graph is "
        "truncated if it does not fit within the specified boundaries.</li>\n"
        "</ul>\n"
        "<p>\n"
        "The arrows have the following meaning:\n"
        "</p>\n"
        "<ul>\n"
        "<li>%A dark blue arrow is used to visualize a public inheritance "
        "relation between two classes.</li>\n"
        "<li>%A dark green arrow is used for protected inheritance.</li>\n"
        "<li>%A dark red arrow is used for private inheritance.</li>\n"
        "<li>%A purple dashed arrow is used if a class is contained or used "
        "by another class. The arrow is labelled with the variable(s) "
        "through which the pointed class or struct is accessible.</li>\n"
        "<li>%A yellow dashed arrow denotes a relation between a template instance and "
        "the template class it was instantiated from. The arrow is labelled with "
        "the template parameters of the instance.</li>\n"
        "</ul>\n";
    }
    virtual QCString trLegend()
    {
      return "legend";
    }

// new since 1.2.0

    virtual QCString trTest()
    {
      return "Test";
    }
    virtual QCString trTestList()
    {
      return "Test List";
    }

// new since 1.2.2

    virtual QCString trProperties()
    {
      return "Properties";
    }
    virtual QCString trPropertyDocumentation()
    {
      return "Property Documentation";
    }

// new since 1.2.4

    virtual QCString trClasses()
    {
      if (Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
      {
        return "Data Structures";
      }
      else
      {
        return "Classes";
      }
    }
    virtual QCString trPackage(const char *name)
    {
      return (QCString)"Package "+name;
    }
    virtual QCString trPackageList()
    {
      return "Package List";
    }
    virtual QCString trPackageListDescription()
    {
      return "Here are the packages with brief descriptions (if available):";
    }
    virtual QCString trPackages()
    {
      return "Packages";
    }
    virtual QCString trDefineValue()
    {
      return "Value:";
    }

// new since 1.2.5

    virtual QCString trBug()
    {
      return "Bug";
    }
    virtual QCString trBugList()
    {
      return "Bug List";
    }

// new since 1.2.6

    virtual QCString trRTFansicp()
    {
      return "1252";
    }


    virtual QCString trRTFCharSet()
    {
      return "0";
    }

    virtual QCString trRTFGeneralIndex()
    {
      return "Index";
    }

    virtual QCString trClass(bool first_capital, bool singular)
    {
      QCString result((first_capital ? "Class" : "class"));
      if (!singular)  result+="es";
      return result;
    }

    virtual QCString trFile(bool first_capital, bool singular)
    {
      QCString result((first_capital ? "File" : "file"));
      if (!singular)  result+="s";
      return result;
    }

    virtual QCString trNamespace(bool first_capital, bool singular)
    {
      QCString result((first_capital ? "Namespace" : "namespace"));
      if (!singular)  result+="s";
      return result;
    }

    virtual QCString trGroup(bool first_capital, bool singular)
    {
      QCString result((first_capital ? "Module" : "module"));
      if (!singular)  result+="s";
      return result;
    }

    virtual QCString trPage(bool first_capital, bool singular)
    {
      QCString result((first_capital ? "Page" : "page"));
      if (!singular)  result+="s";
      return result;
    }

    virtual QCString trMember(bool first_capital, bool singular)
    {
      QCString result((first_capital ? "Member" : "member"));
      if (!singular)  result+="s";
      return result;
    }

    virtual QCString trGlobal(bool first_capital, bool singular)
    {
      QCString result((first_capital ? "Global" : "global"));
      if (!singular)  result+="s";
      return result;
    }

// new since 1.2.7

    virtual QCString trAuthor(bool first_capital, bool singular)
    {
      QCString result((first_capital ? "Author" : "author"));
      if (!singular)  result+="s";
      return result;
    }

// new since 1.2.11

    virtual QCString trReferences()
    {
      return "References";
    }

// new since 1.2.13

    virtual QCString trImplementedFromList(int numEntries)
    {
      return "Implements "+trWriteList(numEntries)+".";
    }

    virtual QCString trImplementedInList(int numEntries)
    {
      return "Implemented in "+trWriteList(numEntries)+".";
    }

// new since 1.2.16

    virtual QCString trRTFTableOfContents()
    {
      return "Table of Contents";
    }

// new since 1.2.17

    virtual QCString trDeprecatedList()
    {
      return "Deprecated List";
    }

// new since 1.2.18

    virtual QCString trEvents()
    {
      return "Events";
    }
    virtual QCString trEventDocumentation()
    {
      return "Event Documentation";
    }

// new since 1.3

    virtual QCString trPackageTypes()
    {
      return "Package Types";
    }
    virtual QCString trPackageMembers()
    {
      return "Package Functions";
    }
    virtual QCString trStaticPackageMembers()
    {
      return "Static Package Functions";
    }
    virtual QCString trPackageAttribs()
    {
      return "Package Attributes";
    }
    virtual QCString trStaticPackageAttribs()
    {
      return "Static Package Attributes";
    }

// new since 1.3.1

    virtual QCString trAll()
    {
      return "All";
    }
    virtual QCString trCallGraph()
    {
      return "Here is the call graph for this function:";
    }

// new since 1.3.3

    virtual QCString trSearchResultsTitle()
    {
      return "Search Results";
    }
    virtual QCString trSearchResults(int numDocuments)
    {
      if (numDocuments==0)
      {
        return "Sorry, no documents matching your query.";
      }
      else if (numDocuments==1)
      {
        return "Found <b>1</b> document matching your query.";
      }
      else
      {
        return "Found <b>$num</b> documents matching your query. "
               "Showing best matches first.";
      }
    }
    virtual QCString trSearchMatches()
    {
      return "Matches:";
    }

// new since 1.3.8

    virtual QCString trSourceFile(QCString& filename)
    {
      return filename + " Source File";
    }

// new since 1.3.9

    virtual QCString trDirIndex()
    { return "Directory Hierarchy"; }

    virtual QCString trDirDocumentation()
    { return "Directory Documentation"; }

    virtual QCString trDirectories()
    { return "Directories"; }

    virtual QCString trDirDescription()
    { return "This directory hierarchy is sorted roughly, "
             "but not completely, alphabetically:";
    }

    virtual QCString trDirReference(const char *dirName)
    { QCString result=dirName; result+=" Directory Reference"; return result; }

    virtual QCString trDir(bool first_capital, bool singular)
    {
      QCString result((first_capital ? "Director" : "director"));
      if (singular) result+="y"; else result+="ies";
      return result;
    }

// new since 1.4.1

    virtual QCString trOverloadText()
    {
       return "This is an overloaded member function, "
              "provided for convenience. It differs from the above "
              "function only in what argument(s) it accepts.";
    }

// new since 1.4.6

    virtual QCString trCallerGraph()
    {
      return "Here is the caller graph for this function:";
    }

    virtual QCString trEnumerationValueDocumentation()
    { return "Enumerator Documentation"; }

// new since 1.5.4 (mainly for Fortran)

    virtual QCString trMemberFunctionDocumentationFortran()
    { return "Member Function/Subroutine Documentation"; }

    virtual QCString trCompoundListFortran()
    { return "Data Types List"; }

    virtual QCString trCompoundMembersFortran()
    { return "Data Fields"; }

    virtual QCString trCompoundListDescriptionFortran()
    { return "Here are the data types with brief descriptions:"; }

    virtual QCString trCompoundMembersDescriptionFortran(bool extractAll)
    {
      QCString result="Here is a list of all ";
      if (!extractAll)
      {
        result+="documented ";
      }
      result+="data types members";
      result+=" with links to ";
      if (!extractAll)
      {
         result+="the data structure documentation for each member";
      }
      else
      {
         result+="the data types they belong to:";
      }
      return result;
    }

    virtual QCString trCompoundIndexFortran()
    { return "Data Type Index"; }

    virtual QCString trTypeDocumentation()
    { return "Data Type Documentation"; }

    virtual QCString trSubprograms()
    { return "Functions/Subroutines"; }

    virtual QCString trSubprogramDocumentation()
    { return "Function/Subroutine Documentation"; }

     virtual QCString trDataTypes()
    { return "Data Types"; }

    virtual QCString trModulesList()
    { return "Modules List"; }

    virtual QCString trModulesListDescription(bool extractAll)
    {
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="modules with brief descriptions:";
      return result;
    }

    virtual QCString trCompoundReferenceFortran(const char *clName,
                                    ClassDef::CompoundType compType,
                                    bool isTemplate)
    {
      QCString result=(QCString)clName;
      switch(compType)
      {
        case ClassDef::Class:      result+=" Module"; break;
        case ClassDef::Struct:     result+=" Type"; break;
        case ClassDef::Union:      result+=" Union"; break;
        case ClassDef::Interface:  result+=" Interface"; break;
        case ClassDef::Protocol:   result+=" Protocol"; break;
        case ClassDef::Category:   result+=" Category"; break;
        case ClassDef::Exception:  result+=" Exception"; break;
        default: break;
      }
      if (isTemplate) result+=" Template";
      result+=" Reference";
      return result;
    }
    virtual QCString trModuleReference(const char *namespaceName)
    {
      QCString result=namespaceName;
      result+=" Module Reference";
      return result;
    }

    virtual QCString trModulesMembers()
    { return "Module Members"; }

    virtual QCString trModulesMemberDescription(bool extractAll)
    {
      QCString result="Here is a list of all ";
      if (!extractAll) result+="documented ";
      result+="module members with links to ";
      if (extractAll)
      {
        result+="the module documentation for each member:";
      }
      else
      {
        result+="the modules they belong to:";
      }
      return result;
    }

    virtual QCString trModulesIndex()
    { return "Modules Index"; }

    virtual QCString trModule(bool first_capital, bool singular)
    {
      QCString result((first_capital ? "Module" : "module"));
      if (!singular)  result+="s";
      return result;
    }

    virtual QCString trGeneratedFromFilesFortran(ClassDef::CompoundType compType,
        bool single)
    {
      // single is true implies a single file
      QCString result=(QCString)"The documentation for this ";
      switch(compType)
      {
        case ClassDef::Class:      result+="module"; break;
        case ClassDef::Struct:     result+="type"; break;
        case ClassDef::Union:      result+="union"; break;
        case ClassDef::Interface:  result+="interface"; break;
        case ClassDef::Protocol:   result+="protocol"; break;
        case ClassDef::Category:   result+="category"; break;
        case ClassDef::Exception:  result+="exception"; break;
        default: break;
      }
      result+=" was generated from the following file";
      if (single) result+=":"; else result+="s:";
      return result;
    }

    virtual QCString trType(bool first_capital, bool singular)
    {
      QCString result((first_capital ? "Type" : "type"));
      if (!singular)  result+="s";
      return result;
    }

    virtual QCString trSubprogram(bool first_capital, bool singular)
    {
      QCString result((first_capital ? "Subprogram" : "subprogram"));
      if (!singular)  result+="s";
      return result;
    }

    virtual QCString trTypeConstraints()
    {
      return "Type Constraints";
    }

// new since 1.6.0 (mainly for the new search engine)

    virtual QCString trDirRelation(const char *name)
    {
      return QCString(name)+" Relation";
    }

    virtual QCString trLoading()
    {
      return "Loading...";
    }

    virtual QCString trGlobalNamespace()
    {
      return "Global Namespace";
    }

    virtual QCString trSearching()
    {
      return "Searching...";
    }

    virtual QCString trNoMatches()
    {
      return "No Matches";
    }

// new since 1.6.3 (missing items for the directory pages)

    virtual QCString trFileIn(const char *name)
    {
      return (QCString)"File in "+name;
    }

    virtual QCString trIncludesFileIn(const char *name)
    {
      return (QCString)"Includes file in "+name;
    }

    virtual QCString trDateTime(int year,int month,int day,int dayOfWeek,
                                int hour,int minutes,int seconds,
                                bool includeTime)
    {
      static const char *days[]   = { "Mon","Tue","Wed","Thu","Fri","Sat","Sun" };
      static const char *months[] = { "Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec" };
      QCString sdate;
      sdate.sprintf("%s %s %d %d",days[dayOfWeek-1],months[month-1],day,year);
      if (includeTime)
      {
        QCString stime;
        stime.sprintf(" %.2d:%.2d:%.2d",hour,minutes,seconds);
        sdate+=stime;
      }
      return sdate;
    }

// new since 1.7.5

    virtual QCString trCiteReferences()
    { return "Bibliography"; }

    virtual QCString trCopyright()
    { return "Copyright"; }

    virtual QCString trDirDepGraph(const char *name)
    { return QCString("Directory dependency graph for ")+name+":"; }

// new since 1.8.0

    virtual QCString trDetailLevel()
    { return "detail level"; }

    virtual QCString trTemplateParameters()
    { return "Template Parameters"; }

    virtual QCString trAndMore(const QCString &number)
    { return "and "+number+" more..."; }

    virtual QCString trEnumGeneratedFromFiles(bool single)
    { QCString result = "The documentation for this enum was generated from the following file";
      if (!single) result += "s";
      result+=":";
      return result;
    }

    virtual QCString trEnumReference(const char *name)
    { return QCString(name)+" Enum Reference"; }

    virtual QCString trInheritedFrom(const char *members,const char *what)
    { return QCString(members)+" inherited from "+what; }

    virtual QCString trAdditionalInheritedMembers()
    { return "Additional Inherited Members"; }

// new since 1.8.2

    virtual QCString trPanelSynchronisationTooltip(bool enable)
    {
      QCString opt = enable ? "enable" : "disable";
      return "click to "+opt+" panel synchronisation";
    }

    virtual QCString trProvidedByCategory()
    {
      return "Provided by category @0.";
    }

    virtual QCString trExtendsClass()
    {
      return "Extends class @0.";
    }

    virtual QCString trClassMethods()
    {
      return "Class Methods";
    }

    virtual QCString trInstanceMethods()
    {
      return "Instance Methods";
    }

    virtual QCString trMethodDocumentation()
    {
      return "Method Documentation";
    }

    virtual QCString trDesignOverview()
    {
      return "Design Overview";
    }

// new since 1.8.4

    virtual QCString trInterfaces()
    { return "Exported Interfaces"; }

    virtual QCString trServices()
    { return "Included Services"; }

    virtual QCString trConstantGroups()
    { return "Constant Groups"; }

    virtual QCString trConstantGroupReference(const char *namespaceName)
    {
      QCString result=namespaceName;
      result+=" Constant Group Reference";
      return result;
    }
    virtual QCString trServiceReference(const char *sName)
    {
      QCString result=(QCString)sName;
      result+=" Service Reference";
      return result;
    }
    virtual QCString trSingletonReference(const char *sName)
    {
      QCString result=(QCString)sName;
      result+=" Singleton Reference";
      return result;
    }
    virtual QCString trServiceGeneratedFromFiles(bool single)
    {
      // single is true implies a single file
      QCString result=(QCString)"The documentation for this service "
                                "was generated from the following file";
      if (single) result+=":"; else result+="s:";
      return result;
    }
    virtual QCString trSingletonGeneratedFromFiles(bool single)
    {
      // single is true implies a single file
      QCString result=(QCString)"The documentation for this singleton "
                                "was generated from the following file";
      if (single) result+=":"; else result+="s:";
      return result;
    }


};

#endif