Package com.io7m.minisite.core

Interface MinConfigurationType

All Known Implementing Classes:

MinConfiguration

@Immutable
public interface MinConfigurationType

Configurations for sites.

Method Summary

Modifier and Type	Method	Description
Optional<MinBugTrackerConfiguration>	bugTracker()
String	centralReposPath()
Optional<MinChangesConfiguration>	changelog()
default boolean	cssGenerateStyle()
default List<String>	cssIncludes()
Optional<Path>	documentation()
Optional<Path>	features()
Optional<Path>	header()
Optional<Path>	license()
Optional<Path>	overview()
String	projectGroupName()
List<String>	projectModules()
String	projectName()
String	release()
Optional<MinSourcesConfiguration>	sources()

Method Details

projectName

@Parameter
String projectName()

Returns:

The name of the project

projectGroupName

@Parameter
String projectGroupName()

Returns:

The group name of the project

projectModules

@Parameter
List<String> projectModules()

Returns:

The project modules

release

@Parameter
String release()

Returns:

The version number of the current release

centralReposPath

@Parameter
String centralReposPath()

Returns:

The path to the project within the Central Repository

header

@Parameter
Optional<Path> header()

Returns:

An XHTML file containing a header inserted above the title and logo in generated sites.

overview

@Parameter
Optional<Path> overview()

Returns:

An XHTML file containing an overview of the project

features

@Parameter
Optional<Path> features()

Returns:

An XHTML file containing the features of the project

documentation

@Parameter
Optional<Path> documentation()

Returns:

An XHTML file containing the documentation links of the project

changelog

@Parameter
Optional<MinChangesConfiguration> changelog()

Returns:

The changelog configuration, if any

license

@Parameter
Optional<Path> license()

Returns:

A plain text file containing the project license

bugTracker

@Parameter
Optional<MinBugTrackerConfiguration> bugTracker()

Returns:

The bug tracker configuration, if any

sources

@Parameter
Optional<MinSourcesConfiguration> sources()

Returns:

The project source configuration, if any

cssIncludes

@Parameter
@Default
default List<String> cssIncludes()

Returns:

The list of stylesheets that will be included by the generated site

cssGenerateStyle

@Default
@Parameter
default boolean cssGenerateStyle()

Returns:

true if the default style should be copied to the generated site directory