Skip to content

Default documentation URLs for UIMA components #44

@reckart

Description

@reckart

It would be great if one could configure default documentation URLs for readers/writers/engines at the POM level instead of having to add a @DocumentationResource in every component.

The value set in the POM should be used as a default. If an annotation is present in the component, it should be used instead.

      <plugin>
        <groupId>eu.openminted.share.annotations</groupId>
        <artifactId>omtd-share-annotations-maven-plugin</artifactId>
        <executions>
          <execution>
            <id>default</id>
            <phase>process-classes</phase>
            <goals>
              <goal>generate</goal>
            </goals>
          </execution>
        </executions>
        <configuration>
          <descriptorLocation>withClasses</descriptorLocation>
          <uimaTypeMappings>
            <uimaTypeMapping>META-INF/eu.openminted.share/uimaTypeMapping.map</uimaTypeMapping>
          </uimaTypeMappings>
          <mimeTypeMappings>
            <mimeTypeMapping>META-INF/eu.openminted.share/mimeTypeMapping.map</mimeTypeMapping>
          </mimeTypeMappings>
          <documentationOnlineHelpUrl>"${docbase}/component-reference.html#engine-${shortClassName}"</documentationOnlineHelpUrl>
          <properties>
            <docbase>https://dkpro.github.io/dkpro-core/releases/${project.version}/docs</docbase>
          </properties>
        </configuration>
      </plugin>

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions