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

org.ysb33r.ysf.projects.antora.AntoraBasePlugin

All Implemented Interfaces and Traits:

Plugin<Project>
```
@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
class AntoraBasePlugin
extends Object
implements Plugin<Project>
```
Base plugin for publishing with Antora.
Authors:
Schalk W. Cronjé
Since:
1.0.0

Field Summary

Fields
Modifiers	Name	Description
`static String`	`ANTORA_YML`
`static String`	`BUILD_TASK_NAME_PUBLISH`
`static String`	`BUILD_TASK_NAME_TEST`
`static String`	`GIT_PUSH_PAGES`
`static String`	`INSTALL_TASK`
`static String`	`NAV_UPDATER_TASK`
`static String`	`PACKAGE_JSON_TASK`
`static String`	`PLAYBOOK_TASK_NAME_LOCAL`
`static String`	`PLAYBOOK_TASK_NAME_PUBLISH`
`static String`	`PLAYBOOK_TASK_NAME_TEST`
`static String`	`PREPROCESSOR_TASK`
`static String`	`PUBLISH_TO_PAGES_KEY_PROPERTY`
`static String`	`PUBLISH_TO_PAGES_SOURCESET`
`static String`	`REDIRECTS_TASK`
`static String`	`ROOT_SUBPATH`
`static String`	`SUBPATH_ANTORA_BUILD_TEST`	Path in build directory into which the current version's documentation is written to.
`static String`	`SUBPATH_ANTORA_LOGS`
`static String`	`SUBPATH_ANTORA_PREPROCESSED`
`static String`	`SUBPATH_ANTORA_REDIRECTS`
`static String`	`SUBPATH_ANTORA_WORKDIR_LOCAL`	This is the directory to use when building locally only.
`static String`	`SUBPATH_ANTORA_WORKDIR_TEST`	This is the directory to use when testing this current version's documentation.

Constructor Summary

Constructors
Constructor and description
`AntoraBasePlugin ()`

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_YML
  - public static final String BUILD_TASK_NAME_PUBLISH
  - public static final String BUILD_TASK_NAME_TEST
  - public static final String GIT_PUSH_PAGES
  - public static final String INSTALL_TASK
  - public static final String NAV_UPDATER_TASK
  - public static final String PACKAGE_JSON_TASK
  - public static final String PLAYBOOK_TASK_NAME_LOCAL
  - public static final String PLAYBOOK_TASK_NAME_PUBLISH
  - public static final String PLAYBOOK_TASK_NAME_TEST
  - public static final String PREPROCESSOR_TASK
  - public static final String PUBLISH_TO_PAGES_KEY_PROPERTY
  - public static final String PUBLISH_TO_PAGES_SOURCESET
  - public static final String REDIRECTS_TASK
  - public static final String ROOT_SUBPATH
  - public static final String SUBPATH_ANTORA_BUILD_TEST
    
    Path in build directory into which the current version's documentation is written to. THis is for fast local building in order to verify that the documentation is built correctly.
  - public static final String SUBPATH_ANTORA_LOGS
  - public static final String SUBPATH_ANTORA_PREPROCESSED
  - public static final String SUBPATH_ANTORA_REDIRECTS
  - public static final String SUBPATH_ANTORA_WORKDIR_LOCAL
    
    This is the directory to use when building locally only. It contains antora-playbook.yml & package.json.
  - public static final String SUBPATH_ANTORA_WORKDIR_TEST
    
    This is the directory to use when testing this current version's documentation. It contains antora-playbook.yml & package.json.
- Constructor Detail
  - AntoraBasePlugin()
- Method Detail
  - @Override void apply(Project project)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class AntoraBasePlugin

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String ANTORA_YML

public static final String BUILD_TASK_NAME_PUBLISH

public static final String BUILD_TASK_NAME_TEST

public static final String GIT_PUSH_PAGES

public static final String INSTALL_TASK

public static final String NAV_UPDATER_TASK

public static final String PACKAGE_JSON_TASK

public static final String PLAYBOOK_TASK_NAME_LOCAL

public static final String PLAYBOOK_TASK_NAME_PUBLISH

public static final String PLAYBOOK_TASK_NAME_TEST

public static final String PREPROCESSOR_TASK

public static final String PUBLISH_TO_PAGES_KEY_PROPERTY

public static final String PUBLISH_TO_PAGES_SOURCESET

public static final String REDIRECTS_TASK

public static final String ROOT_SUBPATH

public static final String SUBPATH_ANTORA_BUILD_TEST

public static final String SUBPATH_ANTORA_LOGS

public static final String SUBPATH_ANTORA_PREPROCESSED

public static final String SUBPATH_ANTORA_REDIRECTS

public static final String SUBPATH_ANTORA_WORKDIR_LOCAL

public static final String SUBPATH_ANTORA_WORKDIR_TEST

Constructor Detail

AntoraBasePlugin()

Method Detail

@Override void apply(Project project)