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.
- Alphabetic
- By Inheritance
- Versions
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def allVersions: Seq[Version]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val currentVersion: Version
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val newerVersions: Seq[Version]
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val olderVersions: Seq[Version]
- val renderUnversioned: Boolean
- val scannerConfig: Option[VersionScannerConfig]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
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.