Module:Tdoc/tags

This is a Lua script module implemented by the Scribunto extension.

return {
	['todo'] = {
        title = 'Todo',
        format = 'comment',
        description = 'Notes for future work and improvements',
    },
	['var'] = {
        title = 'Variables',
        format = 'section',
        description = 'After a template ends, any [[Help:Variables|variable]] it defines will then remain in the global scope of the page. If leveraging, please state the variable\'s name and meaning, and potentially the "recipient" template if it\'s specific enough.'
    },
    ['see'] = {
        title = 'See also',
        format = 'section',
        description = 'Related reading, either immediately relevant, or which lend helpful context. Good for other templates or [[Category:Help|meta-documentation]] sections.'
    },
    ['source'] = {
        title = 'Source',
        format = 'section',
        description = 'Extension or specific MediaWiki version from which a function or item originates.',
    },
    ['ingroup'] = {
        format = 'transclude',
        description = '<noinclude/> [[Pixar Cars Wiki:Categories|category]]',
    },   
    ['param'] = {
        title = 'Parameters',
        format = 'params',
        subparams = { 'type', 'name', ''}, --description        
        description = 'Parameter types, names, and usage descriptions.',
    },
    ['return'] = {
        title = 'Returns',
        format = 'section',
        description = 'What the end output is expected to be. As it will most likely be a [[#string]], follow the same guidelines for describing, also considering other templates or functions that might want to use it.'
    },
    ['throws'] = {
        key = 'exception',
        title = 'Exceptions',
        format = 'params',
        subparams = { 'name', '' },
        description = 'Name of possible \'\'\'debug\'\'\' messages, and conditions which lead to them. Built-in function errors ({{code|pfhook|expr|H}} operation failures, [[Help:Cargo|Cargo SQL warnings]]) should be accommodated and avoided in design of the template, but when depending on user input, replaced with a [[Template:Exception|local message]]. Remember that the former are defined for their own respective [[Help:Parser functions|functions]], not necessarily their use environment – most will be, to the average user, unhelpful jargon.',
    },    
    ['author'] = {
        title = 'Author',
        format = 'section',
        description = 'If the template is copied from another wiki, give credit to the original author(s); at bare minimum, link to their project where the code was obtained. Locally, if your own work is original \'\'\'and\'\'\' significant (something creative or wholistic) feel free to add your name.',
    },
    ['par'] = {
        key = 'user',    	
        format = 'section',
        description = 'Custom code block',
    },    
    ['note'] = {
        title = 'Note',
        format = 'section',
        description = 'Important clarification(s) front-and-center.',
    },
    ['example'] = {
        title = 'Example',
        format = 'section',
        description = 'Free text demo section',
    },
}