AntoraPlugin (ysf-documentation-antora-plugin 1.0.0 API)

org.ysb33r.ysf.projects.antora.AntoraPlugin

All Implemented Interfaces and Traits:: Plugin<Project>

@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
class AntoraPlugin
extends Object
implements Plugin<Project>

Base plugin that is used for both local building and publishing

Field Summary

Fields
Modifiers	Name	Description
`static String`	`ANTORA_CONTENT_TAG_PREFIX`
`static String`	`ARTIFACT_ENTRIES`
`static String`	`BUILD_TASK_NAME_LOCAL`
`static String`	`COMBINE_ALL_NAVS`
`static String`	`IGNORE_ARTIFACT_NAV`
`static String`	`LEGACY_DOCS_ENTRIES`
`static String`	`NAV_ENTRIES_TASK`
`static String`	`PROJECT_ARTIFACT_MODULE`
`static String`	`PUBLISH_TO_GIT_MAIN_SOURCESET`
`static String`	`SUBPATH_ANTORA_BUILD_LOCAL`	Path in build directory into which the intermediate documentation containing HTML content will be written to.
`static String`	`SUBPATH_ANTORA_BUILD_PUBLISH`	Path in build directory into which the final documentation containing HTML pages will be written to.
`static String`	`SUBPATH_ANTORA_NAV_ENTRIES`
`static String`	`SUBPATH_ANTORA_WORKDIR_PUBLISH`	This is the directory from which Antora will run in order to create HTML pages which can then be send to a tagged antora-pages branch.
`static String`	`SUBPATH_DISPLAY_VERSIONS`
`static String`	`SUBPATH_LEGACY_VERSIONS`
`static String`	`SUBPATH_SUPPLEMENTAL_UI_FILES`
`static String`	`VALIDATE_VERSIONS_TASK`
`static String`	`VERSIONED_PAGES_BRANCH`

Constructor Summary

Constructors
Constructor and description
`AntoraPlugin ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`apply(Project project)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, toString, hashCode, getClass, notify, notifyAll, wait, wait, wait`

- Field Detail
  - public static final String ANTORA_CONTENT_TAG_PREFIX
  - public static final String ARTIFACT_ENTRIES
  - public static final String BUILD_TASK_NAME_LOCAL
  - public static final String COMBINE_ALL_NAVS
  - public static final String IGNORE_ARTIFACT_NAV
  - public static final String LEGACY_DOCS_ENTRIES
  - public static final String NAV_ENTRIES_TASK
  - public static final String PROJECT_ARTIFACT_MODULE
  - public static final String PUBLISH_TO_GIT_MAIN_SOURCESET
  - public static final String SUBPATH_ANTORA_BUILD_LOCAL
    
    Path in build directory into which the intermediate documentation containing HTML content will be written to. It is purely for viewing the current version's documentation alongside with previous versions.
  - public static final String SUBPATH_ANTORA_BUILD_PUBLISH
    
    Path in build directory into which the final documentation containing HTML pages will be written to. Content is this directory will be consumed by the gitPublishPagesCopy task.
  - public static final String SUBPATH_ANTORA_NAV_ENTRIES
  - public static final String SUBPATH_ANTORA_WORKDIR_PUBLISH
    
    This is the directory from which Antora will run in order to create HTML pages which can then be send to a tagged antora-pages branch. It contains antora-playbook.yml & package.json.
  - public static final String SUBPATH_DISPLAY_VERSIONS
  - public static final String SUBPATH_LEGACY_VERSIONS
  - public static final String SUBPATH_SUPPLEMENTAL_UI_FILES
  - public static final String VALIDATE_VERSIONS_TASK
  - public static final String VERSIONED_PAGES_BRANCH
- Constructor Detail
  - AntoraPlugin()
- Method Detail
  - @Override void apply(Project project)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class AntoraPlugin

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String ANTORA_CONTENT_TAG_PREFIX

public static final String ARTIFACT_ENTRIES

public static final String BUILD_TASK_NAME_LOCAL

public static final String COMBINE_ALL_NAVS

public static final String IGNORE_ARTIFACT_NAV

public static final String LEGACY_DOCS_ENTRIES

public static final String NAV_ENTRIES_TASK

public static final String PROJECT_ARTIFACT_MODULE

public static final String PUBLISH_TO_GIT_MAIN_SOURCESET

public static final String SUBPATH_ANTORA_BUILD_LOCAL

public static final String SUBPATH_ANTORA_BUILD_PUBLISH

public static final String SUBPATH_ANTORA_NAV_ENTRIES

public static final String SUBPATH_ANTORA_WORKDIR_PUBLISH

public static final String SUBPATH_DISPLAY_VERSIONS

public static final String SUBPATH_LEGACY_VERSIONS

public static final String SUBPATH_SUPPLEMENTAL_UI_FILES

public static final String VALIDATE_VERSIONS_TASK

public static final String VERSIONED_PAGES_BRANCH

Constructor Detail

AntoraPlugin()

Method Detail

@Override void apply(Project project)