Module:Namespace detect/config: Difference between revisions

    From Nonbinary Wiki
    m>Mr. Stradivarius
    (create separate configuration page for Module:Namespace detect)
     
    m>Mr. Stradivarius
    (make comments more informative, and document the possibility to add parameter as an array)
    Line 1: Line 1:
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------
    --                    Namespace detect configuration data                    --
    --                    Namespace detect configuration data                    --
    --                                                                            --
    -- This module stores configuration data for Module:Namespace detect. Here    --
    -- you can localise the module to your wiki's language.                      --
    --                                                                            --
    -- To activate a configuration item, you need to uncomment it. This means    --
    -- that you need to remove the text "-- " at the start of the line.          --
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------


    local cfg = {}
    local cfg = {} -- Don't edit this line.


    -- This parameter displays content for the main namespace:
    --------------------------------------------------------------------------------
    cfg.main = 'main'
    --                              Parameter names                              --
    -- These configuration items specify custom parameter names. Values added    --
    -- here will work in addition to the default English parameter names.        --
    -- To add one extra name, you can use this format:                           --
    --                                                                            --
    -- cfg.foo = 'parameter name'                                                 --
    --                                                                            --
    -- To add multiple names, you can use this format:                            --
    --                                                                            --
    -- cfg.foo = {'parameter name 1', 'parameter name 2', 'parameter name 3'}    --
    --------------------------------------------------------------------------------


    -- This parameter displays in talk namespaces:
    ---- This parameter displays content for the main namespace:
    cfg.talk = 'talk'
    -- cfg.main = 'main'


    -- This parameter displays content for "other" namespaces (namespaces for which
    ---- This parameter displays in talk namespaces:
    -- parameters have not been specified, or for when cfg.demospace is set to
    -- cfg.talk = 'talk'
    -- cfg.other):
    cfg.other = 'other'


    -- This parameter makes talk pages behave as though they are the corresponding
    ---- This parameter displays content for "other" namespaces (namespaces for which
    -- subject namespace. Note that this parameter is used with [[Module:Yesno]].
    ---- parameters have not been specified):
    -- Edit that module to change the default values of "yes", "no", etc.
    -- cfg.other = 'other'
    cfg.subjectns = 'subjectns'


    -- This parameter sets a demonstration namespace:
    ---- This parameter makes talk pages behave as though they are the corresponding
    cfg.demospace = 'demospace'
    ---- subject namespace. Note that this parameter is used with [[Module:Yesno]].
    ---- Edit that module to change the default values of "yes", "no", etc.
    -- cfg.subjectns = 'subjectns'


    -- This parameter sets a specific page to compare:
    ---- This parameter sets a demonstration namespace:
    cfg.page = 'page'
    -- cfg.demospace = 'demospace'


    -- The header for the namespace column in the wikitable containing the list of
    ---- This parameter sets a specific page to compare:
    -- possible subject-space parameters.
    -- cfg.page = 'page'
    cfg.wikitableNamespaceHeader = 'Namespace'


    -- The header for the wikitable containing the list of possible subject-space
    --------------------------------------------------------------------------------
    -- parameters.
    --                          Table configuration                              --
    cfg.wikitableAliasesHeader = 'Aliases'
    -- These configuration items allow customisation of the "table" function,    --
    -- used to generate a table of possible parameters in the module              --
    -- documentation.                                                            --
    --------------------------------------------------------------------------------
     
    ---- The header for the namespace column in the wikitable containing the list of
    ---- possible subject-space parameters.
    -- cfg.wikitableNamespaceHeader = 'Namespace'
     
    ---- The header for the wikitable containing the list of possible subject-space
    ---- parameters.
    -- cfg.wikitableAliasesHeader = 'Aliases'
     
    --------------------------------------------------------------------------------
    --                        End of configuration data                          --
    --------------------------------------------------------------------------------


    return cfg
    return cfg -- Don't edit this line.

    Revision as of 13:11, 22 March 2014

    Documentation for this module may be created at Module:Namespace detect/config/doc

    --------------------------------------------------------------------------------
    --                    Namespace detect configuration data                     --
    --                                                                            --
    -- This module stores configuration data for Module:Namespace detect. Here    --
    -- you can localise the module to your wiki's language.                       --
    --                                                                            --
    -- To activate a configuration item, you need to uncomment it. This means     --
    -- that you need to remove the text "-- " at the start of the line.           --
    --------------------------------------------------------------------------------
    
    local cfg = {} -- Don't edit this line.
    
    --------------------------------------------------------------------------------
    --                              Parameter names                               --
    -- These configuration items specify custom parameter names. Values added     --
    -- here will work in addition to the default English parameter names.         --
    -- To add one extra name, you can use this format:                            --
    --                                                                            --
    -- cfg.foo = 'parameter name'                                                 --
    --                                                                            --
    -- To add multiple names, you can use this format:                            --
    --                                                                            --
    -- cfg.foo = {'parameter name 1', 'parameter name 2', 'parameter name 3'}     --
    --------------------------------------------------------------------------------
    
    ---- This parameter displays content for the main namespace:
    -- cfg.main = 'main'
    
    ---- This parameter displays in talk namespaces:
    -- cfg.talk = 'talk'
    
    ---- This parameter displays content for "other" namespaces (namespaces for which
    ---- parameters have not been specified):
    -- cfg.other = 'other'
    
    ---- This parameter makes talk pages behave as though they are the corresponding
    ---- subject namespace. Note that this parameter is used with [[Module:Yesno]].
    ---- Edit that module to change the default values of "yes", "no", etc.
    -- cfg.subjectns = 'subjectns'
    
    ---- This parameter sets a demonstration namespace:
    -- cfg.demospace = 'demospace'
    
    ---- This parameter sets a specific page to compare:
    -- cfg.page = 'page'
    
    --------------------------------------------------------------------------------
    --                           Table configuration                              --
    -- These configuration items allow customisation of the "table" function,     --
    -- used to generate a table of possible parameters in the module              --
    -- documentation.                                                             --
    --------------------------------------------------------------------------------
    
    ---- The header for the namespace column in the wikitable containing the list of
    ---- possible subject-space parameters.
    -- cfg.wikitableNamespaceHeader = 'Namespace'
    
    ---- The header for the wikitable containing the list of possible subject-space
    ---- parameters.
    -- cfg.wikitableAliasesHeader = 'Aliases'
    
    --------------------------------------------------------------------------------
    --                        End of configuration data                           --
    --------------------------------------------------------------------------------
    
    return cfg -- Don't edit this line.