org.asciidoctor.gradle.model5.core.publications

Interface AsciidoctorDocInfo

All Superinterfaces:

CanConfigureTaskInputs, HasAttributeProvider

public interface AsciidoctorDocInfo
extends HasAttributeProvider, CanConfigureTaskInputs

Methods for configuring docinfo

Since:

5.0

Method Summary

Modifier and Type	Method and Description
void	setDocInfoDir(java.lang.Object dir) Fix a specific directory to contain docinfo content.
void	setFooterIsPrivate(boolean flag) Setting this will apply to all source files in the source set.
void	setHeaderIsPrivate(boolean flag) Setting this will apply to all source files in the source set.
void	setHeadIsPrivate(boolean flag) Setting this will apply to all source files in the source set.

Methods inherited from interface org.asciidoctor.gradle.model5.core.attributes.HasAttributeProvider

getAttributeProvider

Methods inherited from interface org.asciidoctor.gradle.model5.core.CanConfigureTaskInputs

configureTaskInputs

Method Detail

setHeadIsPrivate

void setHeadIsPrivate(boolean flag)

Setting this will apply to all source files in the source set. It can still be overridden in a file.

Parameters:

flag - true to have private docinfo files.

setHeaderIsPrivate

void setHeaderIsPrivate(boolean flag)

Setting this will apply to all source files in the source set. It can still be overridden in a file.

Parameters:

flag - true to have private docinfo files.

setFooterIsPrivate

void setFooterIsPrivate(boolean flag)

Setting this will apply to all source files in the source set. It can still be overridden in a file.

Parameters:

flag - true to have private docinfo files.

setDocInfoDir

void setDocInfoDir(java.lang.Object dir)

Fix a specific directory to contain docinfo content.

Normally base dir determines docinfo discovery. If this is set, the base dir will be ignored.

Changes to any docinfo file in this directory will cause all conversion tasks related to the source set to be out-of-date. Currently, this includes even the tasks that are not docinfo-aware. Be wary of this constraint when using a common directory.

Parameters:

dir - Anything lazy-evaluatable to a directory.