udocumentationtexts.pas

DelphiDoc is a program for automatic generation of documentation on a Delphi-Project. At the momen

{  JADD - Just Another DelphiDoc: Documentation from Delphi Source Code

Copyright (C) 2003-2008   Gerold Veith

This file is part of JADD - Just Another DelphiDoc.

DelphiDoc is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License version 3 as
published by the Free Software Foundation.

DelphiDoc is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
}


unit UDocumentationTexts;

{Contains types and constants for the different texts used in the generators of
 documentation and a special "generator" that can be used to edit, save and
 load these texts. }

interface

uses Classes,
     UPascalConsts,
     UOptions;


      {All texts of the generators that can be changed/localized.
       Each enumeration item means an entry in the array
       ~[link DocumentationTexts] containing the string to be used. For a
       description of each item see the corresponding entry in the array or
       start the executable file and take a look at the "Localization"
       button. }
type  TDocumentationTexts = (


//UPascalConsts

        dtScopeUnknown,
        dtScopeInterface,
        dtScopeImplementation,
        dtScopePrivate,
        dtScopeProtected,
        dtScopePublic,
        dtScopePublished,
        dtScopeAutomated,
        dtScopeLocal,
        dtPortabilityDeprecated,
        dtPortabilityLibrary,
        dtPortabilityPlatform,
        dtAbstract,
        dtPropertyReadOnly,
        dtRecordsHeader,
        dtObjectsHeader,
        dtClassesHeader,
        dtInterfacesHeader,
        dtDispInterfacesHeader,


//TMakeDoc

        dtRecordLikeTypeWithUnscopedMembers,
        dtInvalidIdentifier,


//TDocumentDoc

        dtImplementedInterfaceOfPropertyDoesNotMatch,
        dtInterfaceOfMethodNotImplemented,
        dtUnitUsedByAliasPre,
        dtUnitUsedByAliasPost,


//TCommentDoc

        dtUserDocPageNameNotUnique,
        dtInvalidNameForDefineText,
        dtInvalidNameForInsertText,

        dtNoOperatorForDefineTextIf,
        dtInvalidOperatorForDefineTextIf,
        dtMissingNameForDefineTextIf,

        dtUnknownSectionInComment,
        dtSingleCommandChar,
        dtUnclosedInlineCommand,

        dtInlineCommandWithoutArgument,
        dtInvalidNumericArguments,
        dtUserDocFileNotFound,
        dtFileWithRawDataToIncludeNotFound,
        dtRawDataNotSupportedInPDF,
        dtImageInImage,
        dtImageLinkOutsideImage,
        dtImageInsideInlineCommand,
        dtImageFileNotFound,
        dtInvalidLinkCommand,
        dtImageWithMultipleAndWholeLink,
        dtMustConvertImageManually,
        dtImagesInLaTeXNotSupported,
        dtImagesInManuallyUserDocInPDFNotSupported,
        dtGUIHelpDocumentationNotFound,
        dtUnknownPageName,
        dtUnknownInlineCommand,

        dtSelfLinkOutsideOfContext,
        dtUnknownLinkTarget,
        dtInvalidPositionForInheritanceOfDocumentation,
        dtNotInARecordLikeTypeForInheritance,
        dtInvalidIdentWhileSearchingAncestorIdent,
        dtNoAncestorWithDocumentation,


//TFormatCommentDoc

        dtGUIHelpDefaultCommentDefaultHeading,
        dtSpecialDeprecatedIdentifier,
        dtSpecialDeprecatedFile,
        dtSpecialDeprecated,
        dtSpecialToDo,
        dtSpecialFeature,
        dtParameterCommentedTwice,
        dtCommentedParameterUnknown,
        dtParameterNotCommented,
        dtAllParametersNotCommented,
        dtResultNotCommented,
        dtGUIHelpScreenShotHint,
        dtGUIHelpManualLinkHint,
        dtDiagramHint,


//THTMLDoc

        dtHelpContextFileTitle,
        dtHelpContextFileText1,
        dtHelpContextFileText2,
        dtHelpContextFileLinksHeader,
        dtHelpContextFilePreLink,
        dtHelpContextFileLinkText,
        dtHelpContextFilePostLink,
        dtHelpContextFileJSAlertUnknown,
        dtHelpContextFileJSAlertNoHelpContext,


        dtGUIHelpHTMLScreenShotHeader,
        dtGUIHelpHTMLTopLink,
        dtGUIHelpHeaderComponentsDocumentation,
        dtFileListIndependentUnits,
        dtFileListIncludedFilesPre,
        dtFileListIncludedFilesPost,
        dtClassesHierarchyImplements,
        dtClassesHierarchyEmpty,
        dtCommentAuthor,
        dtCommentVersion,
        dtCommentAdditionalAttribute1,
        dtCommentAdditionalAttribute2,
        dtCommentAdditionalAttribute3,
        dtCommentsSeeAlso,
        dtCommentsExample,
        dtCommentsFileComment,
        dtCommentsParameterHeading,
        dtCommentsResultHeading,
        dtCommentsExceptionHeading,
        dtCommentsOverridesHeading,
        dtCommentsOverriddenByHeading,
        dtCommentsGlobalsHeading,
        dtCommentsCallsHeading,
        dtCommentsUsedHeading,
        dtCommentsUsedFuncHeading,
        dtCommentsUnitUsedByHeading,
        dtCommentsUnitUsedByProgramsHeading,
        dtCommentsUnitUsedByInterfaceHeading,
        dtCommentsUnitUsedByImplementationHeading,
        dtCommentsPackageRequiredByHeading,

        dtDocumentationLinkIndex,
        dtDocumentationLinkFiles,
        dtDocumentationLinkLegend,
        dtDocumentationLinkGetXFig,
        dtDocumentationLinkedXFigFileHeader,
        dtDocumentationLinkXFigFiles,
        dtDocumentationLinkWMFFiles,
        dtDocumentationLinkGetSVG1,
        dtDocumentationLinkGetSVG2,
        dtDocumentationLinkSVGFiles,

        dtDocumentationFilesListTopic,
        dtDocumentationEmptyList,

        dtDocumentationFileDeclarationsHeaderVar,
        dtDocumentationFileDeclarationsHeaderThreadVar,
        dtDocumentationFileDeclarationsHeaderConst,
        dtDocumentationFileDeclarationsHeaderResourceString,
        dtDocumentationFileDeclarationsHeaderSimpleTypes,
        dtDocumentationFileDeclarationsHeaderFunctions,
        dtDocumentationFileDeclarationsHeaderPrefix,
        dtDocumentationFileDeclarationsHeaderMiddle,
        dtDocumentationFileDeclarationsHeaderMiddle2,
        dtDocumentationFileDeclarationsHeaderGlobalPrefix,
        dtDocumentationFileDeclarationsHeaderLocalPrefix,

        dtDocumentationParametersForProgram,
        dtDocumentationPackageRequires,
        dtDocumentationPackageRequiresNoPackage,
        dtDocumentationProjectRequires,
        dtDocumentationExportedIdentifiers,
        dtDocumentationExportedNoIdentifiers,
        dtDocumentationUsedUnits,
        dtDocumentationUsedUnitsInterface,
        dtDocumentationUsedUnitsImplementation,
        dtDocumentationUsedUnitsByProject,
        dtDocumentationUsedUnitsByPackage,
        dtDocumentationUsedUnitsNone,

        dtDocumentationClassListHeaderRecord,
        dtDocumentationClassListHeaderObject,
        dtDocumentationClassListHeaderClass,
        dtDocumentationClassListHeaderInterface,
        dtDocumentationClassListHeaderDispInterface,

        dtDocumentationClassListHeaderPrefix,
        dtDocumentationClassInheritedMembersPrefix,
        dtDocumentationClassInheritedInMiddle,
        dtDocumentationClassInheritedInMiddle2,
        dtDocumentationClassMembersByNamePostfix,
        dtDocumentationClassMemberListHeaderPrefix,
        dtDocumentationClassDeclaredInFile,
        dtDocumentationClassGUID,
        dtDocumentationClassPackedPre,
        dtDocumentationClassPackedPost,
        dtDocumentationClassAbstractPre,
        dtDocumentationClassAbstractPost,

        dtDocumentationClassImplementedInterfaces,
        dtDocumentationClassNoDirectImplementedInterfaces,
        dtDocumentationClassImplementedByAncestors,
        dtDocumentationClassDirectSubclasses,
        dtDocumentationClassNoSubclasses,
        dtDocumentationClassImplementingClasses,
        dtDocumentationClassNoImplementingClasses,
        dtDocumentationClassUsedByClasses,
        dtDocumentationClassNotUsedByClasses,
        dtDocumentationClassAbstractMethods,
        dtCommentsClassComment,
        dtDocumentationClassMembersFields,
        dtDocumentationClassMembersConstructors,
        dtDocumentationClassMembersDestructors,
        dtDocumentationClassMembersMethods,
        dtDocumentationClassMembersProperties,


        dtDocumentationExported,
        dtDocumentationExportedByFile,
        dtDocumentationExportedByFilePre,
        dtDocumentationExportedByFilePost,
        dtDocumentationExportedIdent,
        dtDocumentationExportedIndex,
        dtDocumentationExportedName,
        dtDocumentationExportedResident,
        dtDocumentationExportedDefFile,

        dtDocumentationLongFunctions,
        dtDocumentationLongFunctionsLinesLong,
        dtDocumentationLongFunctionsLinesMiddle,
        dtDocumentationLongFunctionsLinesShort,
        dtDocumentationLongFunctionsNames,
        dtDocumentationIndexPre,
        dtDocumentationIndexPost,
        dtDocumentationIndexFile,
        dtDocumentationIndexClass,
        dtDocumentationIndexIdentifier,


        dtDocumentationIdentListHeaderPre,
        dtDocumentationIdentListHeaderPost,
        dtDocumentationIdentListLinkFilesPre,
        dtDocumentationIdentListLinkFilesPost,
        dtDocumentationIdentListLinkFilesShort,
        dtDocumentationIdentListListOfFilesPre,
        dtDocumentationIdentListListOfFilesPost,
        dtDocumentationIdentListLinkClassesPre,
        dtDocumentationIdentListLinkClassesPost,
        dtDocumentationIdentListLinkClassesShort,
        dtDocumentationIdentListListOfClassesPre,
        dtDocumentationIdentListListOfClassesPost,
        dtDocumentationIdentListLinkIdentsAlphaPre,
        dtDocumentationIdentListLinkIdentsAlphaPost,
        dtDocumentationIdentListLinkIdentsAlphaShort,
        dtDocumentationIdentListListOfIdentsAlphaPre,
        dtDocumentationIdentListListOfIdentsAlphaPost,
        dtDocumentationIdentListLinkIdentsByClassPre,
        dtDocumentationIdentListLinkIdentsByClassPost,
        dtDocumentationIdentListLinkIdentsByClassShort,
        dtDocumentationIdentListListOfIdentsByClassPre,
        dtDocumentationIdentListListOfIdentsByClassPost,


//UWinHelpDoc

        dtDocumentationExampleForPrefix,
        dtDocumentationExampleLinkPrefix,
        dtDocumentationFilesListsRecordLikesHeaderPrefix,
        dtDocumentationFilesLinkListsRecordLikes,
        dtDocumentationClassesLinkMemberListAlphabetically,
        dtDocumentationClassesLinkMemberListByClass,
        dtDocumentationLinkUserIndex,
        dtDocumentationLinkLegendFields,
        dtDocumentationLinkLegendProperties,
        dtDocumentationLinkLegendMethods,
        dtDocumentationLinkLegendInFiles,
        dtDocumentationLinkLegendClasses,
        dtDocumentationLinkExported,
        dtDocumentationLinkExportedByFile,


//ULaTeXDoc

        dtDocumentationLinkRecordLikePre,
        dtDocumentationLinkRecordLikeChapterPrefix,
        dtDocumentationLinkRecordLikeMiddle,
        dtDocumentationLinkRecordLikePost,


//Index

        dtIndexTitle,
        dtIndexThisIsTheIndex,
        dtIndexDocumentationGeneratedAtPre,
        dtIndexDocumentationGeneratedAtMiddle,
        dtIndexDocumentationGeneratedAtPost,
        dtIndexLinkUserDocumentationPre,
        dtIndexLinkUserDocumentationPost,
        dtListsLinkPre,
        dtListsLinkPost,
        dtSpecialDescriptionToDo,
        dtSpecialDescriptionFeature,
        dtListExportedLinkPre,
        dtListExportedLinkLink,
        dtListExportedLinkMiddle,
        dtListExportedLinkLinkFile,
        dtListExportedLinkPost,
        dtListLongFunctionsLinkPre,
        dtListLongFunctionsLinkLink,
        dtListLongFunctionsLinkPost,
        dtDocumentationIndexLinkPre,
        dtDocumentationIndexLinkLink,
        dtDocumentationIndexLinkPost,


//UWinHelpDoc

        dtErrorHTTPLinkHeader,
        dtErrorHTTPLink1,
        dtErrorHTTPLink2,
        dtErrorHTTPLink3,
        dtErrorHTTPLink4,

        dtErrorXFigFileLinkHeader,
        dtErrorXFigFileLink1,
        dtErrorXFigFileLink2,
        dtErrorXFigFileLink3Pre,
        dtErrorXFigFileLink3Post,
        dtErrorXFigFileLink4,
        dtErrorXFigFileLink5,
        dtErrorXFigFileLink6,

        dtErrorWMFFileLinkHeader,
        dtErrorWMFFileLink1,
        dtErrorWMFFileLink2,
        dtErrorWMFFileLink3,
        dtErrorWMFFileLink4,
        dtErrorWMFFileLink5,

        dtErrorSVGFileLinkHeader,
        dtErrorSVGFileLink1,
        dtErrorSVGFileLink2,
        dtErrorSVGFileLink3Pre,
        dtErrorSVGFileLink3Post,
        dtErrorSVGFileLink4Pre,
        dtErrorSVGFileLink4Middle,
        dtErrorSVGFileLink4Post,
        dtErrorSVGFileLink5,
        dtErrorSVGFileLink6,



        dtDocumentationLinkListOfFilesPre,
        dtDocumentationLinkListOfFilesLink,
        dtDocumentationLinkListOfFilesPost,
        dtDocumentationLinkListOfClassesPre,
        dtDocumentationLinkListOfClassesLink,
        dtDocumentationLinkListOfClassesMiddle,
        dtDocumentationLinkListOfClassesPost,
        dtWinHelpCompiledAt,
        dtWinHelpButtonOverview,
        dtWinHelpButtonHistory,
        dtWinHelpButtonOptions,


//ULaTeXDoc

        dtIndexDocumentationByDelphiDoc,
        dtIndexDocumentationOfOf,
        dtIndexGenerationDateTimeMiddle,
        dtIndexDocumentTitle,
        dtIndexDocumentAuthor,
        dtIndexDocumentDateTimeMiddle,
        dtLaTeXTextLinkFormat,
        dtIndexDocumentationOfDocumentation,
        dtIndexGeneratedBy,
        dtIndexGeneratedByDelphiDoc,
        dtDocumentationGUIHelpHeader,
        dtDocumentationUserDocumentationHeader,
        dtDocumentationFilesHeader,
        dtDocumentationListsHeader,


//UPDFDoc

        dtTableOfContentsHeader,
        dtPDFDocumentKeywords,


//key words

        dtKeyWordExample,
        dtKeyWordListFiles,
        dtKeyWordListExportedIdentifiers,
        dtKeyWordListLongFunctions,
        dtKeyWordListPlatform,
        dtKeyWordListLibrary,
        dtKeyWordListDeprecated,
        dtKeyWordListToDo,
        dtKeyWordListFeature,
        dtKeyWordIndexPrefix,
        dtKeyWordUserDocPage,
        dtKeyWordGUIHelpDefault,
        dtKeyWordMainIndex,
        dtKeyWordRecordLikeListPostfix


      );






     //entry of a text of the generators that can be changed/localized
type TTextEntry = record
                    //the localized text
                    T: String;
                    //name of the text for editing, saving and loading
                    N: String;
                    //category of the text when editing it