Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Default documentation URLs for UIMA components #44

Open
reckart opened this issue May 13, 2018 · 0 comments
Open

Default documentation URLs for UIMA components #44

reckart opened this issue May 13, 2018 · 0 comments
Milestone

Comments

@reckart
Copy link
Member

reckart commented May 13, 2018

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>
@reckart reckart added this to the 3.0.2.7 milestone May 13, 2018
@reckart reckart modified the milestones: 3.0.2.7, 3.0.2.8 May 21, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant