docs.fs_AntoraModuleFolder - FN

type: FN ( scalar function ), modify_date: 2021-10-02 13:23:34

RepoObject_guid: 39415EC3-7A22-EC11-8524-A81E8446D5B0

Description

generate AntoraModuleFolder for Antora export based on cofiguration

use @cultures_name as suffix if @cultures_name <> ''

Examples

Example 1. Usage
Select
    a = docs.fs_AntoraModuleFolder ( Default )
  , b = docs.fs_AntoraModuleFolder ( 'en-US' )

Parameters

  • (nvarchar(1024))

  • @cultures_name (nvarchar(10))

Entity Diagram

entity-docs.fs_antoramodulefolder

References

Object Reference Diagram - 1 1

entity_1_1_objectref-docs.fs_antoramodulefolder

Object Reference Diagram - Referenced - 30 0

entity_30_0_objectref-docs.fs_antoramodulefolder

Object Reference Diagram - Referencing - 0 30

entity_0_30_objectref-docs.fs_antoramodulefolder

sql_modules_definition

docs.fs_AntoraModuleFolder - FN script
/*
<<property_start>>Description
generate AntoraModuleFolder for Antora export based on cofiguration

use @cultures_name as suffix if @cultures_name <> ''
<<property_end>>
<<property_start>>exampleUsage
Select
    a = docs.fs_AntoraModuleFolder ( Default )
  , b = docs.fs_AntoraModuleFolder ( 'en-US' )
<<property_end>>
*/
CREATE Function docs.fs_AntoraModuleFolder
(
    @cultures_name NVarchar(10) = ''
)
Returns NVarchar(1024)
As
Begin
    Return ( config.fs_get_parameter_value ( 'AntoraComponentFolder', '' ) + '\modules\'
             + config.fs_get_parameter_value ( 'AntoraModule', '' ) + Iif(@cultures_name <> '', '-', '')
             + @cultures_name
           )
End