Packages

case class Versions(currentVersion: Version, olderVersions: Seq[Version], newerVersions: Seq[Version] = Nil, renderUnversioned: Boolean = true, scannerConfig: Option[VersionScannerConfig] = None) extends Product with Serializable

Global configuration for versioned documentation.

The order in the Seq properties will be used for any list views in the UI (e.g. for the version chooser dropdown).

currentVersion

the version that the sources of a transformation produce

olderVersions

list of older versions that have previously been rendered (may be empty)

newerVersions

list of newer versions that have previously been rendered (may be empty)

renderUnversioned

indicates whether unversioned documents should be rendered (setting this to false may be useful when re-rendering older versions)

scannerConfig

optional configuration for scanning and indexing existing versions, used by the Helium version switcher dropdown and by the preview server.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Versions
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Versions(currentVersion: Version, olderVersions: Seq[Version], newerVersions: Seq[Version] = Nil, renderUnversioned: Boolean = true, scannerConfig: Option[VersionScannerConfig] = None)

    currentVersion

    the version that the sources of a transformation produce

    olderVersions

    list of older versions that have previously been rendered (may be empty)

    newerVersions

    list of newer versions that have previously been rendered (may be empty)

    renderUnversioned

    indicates whether unversioned documents should be rendered (setting this to false may be useful when re-rendering older versions)

    scannerConfig

    optional configuration for scanning and indexing existing versions, used by the Helium version switcher dropdown and by the preview server.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. lazy val allVersions: Seq[Version]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. val currentVersion: Version
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. val newerVersions: Seq[Version]
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. val olderVersions: Seq[Version]
  16. val renderUnversioned: Boolean
  17. val scannerConfig: Option[VersionScannerConfig]
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def validated: Either[NonEmptyChain[String], Versions]

    Validates this configuration instance and either returns a Left with a list of errors encountered or a Right containing this instance.

  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. def withVersionScanner(rootDirectory: String, exclude: Seq[Path]): Versions

    Configures the version scanner to use during transformations.

    Configures the version scanner to use during transformations. These settings enable scanning and indexing existing versions during a transformation, used by the Helium version switcher dropdown and by the preview server.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped