Package lumis.portal.documentation

Interface IDocumentationManager

  • public interface IDocumentationManager
    The documentation manager interface.
    Since:
    9.0.0
    Version:
    $Revision$ $Date$

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void generateDocumentation​(java.lang.String sourceRootPath, boolean reGenerateImages, java.util.Locale locale, boolean insertStringHolders)
      Generates documentation for one or more services and static directories specified in a documentationdefinition.xml file
      void generateServiceDocumentation​(java.lang.String serviceId, boolean reGenerateImages, java.util.Locale locale, boolean insertStringHolders)
      Generates documentation for a given service.
      void generateStaticDocumentation​(java.lang.String sourceRootPath, java.util.Locale locale)
      Generates documentation given a root directory.

    • Method Detail

      • generateServiceDocumentation

        void generateServiceDocumentation​(java.lang.String serviceId,
                                  boolean reGenerateImages,
                                  java.util.Locale locale,
                                  boolean insertStringHolders)
                           throws PortalException
        Generates documentation for a given service.
        Parameters:
        serviceId - the identifier of the service
        reGenerateImages - true if during generation of documentation, autogeneration of images should also be executed.
        locale - the locale in which the documentation should be generated.
        insertStringHolders - if true, will generate the string id of non-localized strings for ease of translation
        Throws:
        PortalException
        Since:
        9.0.0

      • generateStaticDocumentation

        void generateStaticDocumentation​(java.lang.String sourceRootPath,
                                 java.util.Locale locale)
                          throws PortalException
        Generates documentation given a root directory. The root directory should have a sub-directory named with the locale that the documentation manager is trying to generate.
        Parameters:
        sourceRootPath - the root directory generally ending with documentationfiles directory.
        locale - the locale in which the documentation should be generated.
        Throws:
        PortalException
        Since:
        9.0.0

      • generateDocumentation

        void generateDocumentation​(java.lang.String sourceRootPath,
                           boolean reGenerateImages,
                           java.util.Locale locale,
                           boolean insertStringHolders)
                    throws PortalException
        Generates documentation for one or more services and static directories specified in a documentationdefinition.xml file
        Parameters:
        sourceRootPath - the root path that should contain a documentationdefinition.xml file
        reGenerateImages - true if during generation of documentation, autogeneration of service images should also be executed.
        locale - the locale in which the documentation should be generated.
        insertStringHolders - if true, will generate the string id of non-localized strings for ease of translation
        Throws:
        PortalException
        Since:
        9.0.0