Módulo:OutputBuffer/doc

Esta é uma subpágina de documentação para o Módulo:OutputBuffer.
Ela contém informações sobre o seu uso, categorias, bem como todo o conteúdo que não faz parte do módulo original.

Este módulo serve para gerar de uma maneira façil e eficiente um texto comprido. Um buffer é um espaço tampão de texto, usado nas funções do módulo.

Uso editar

Primeiro, carregue o módulo.

local newBuffer = require('Módulo:OutputBuffer')

Depois, crie o buffer e as funções que atuam sobre este.

local getBuffer, print, printf = newBuffer()

getBuffer editar

local text = getBuffer(sep)

Devolve o conteúdo do buffer, com um separador opcional texto sep.

print editar

print(s)

Adiciona o texto s ao buffer.

printf editar

printf(s, ...)

Adiciona o texto s ao buffer. O texto é formatado com argumentos subsequentes, seguindo as regras usadas para string.format.

Exemplo editar

local newBuffer = require('Módulo:OutputBuffer')
local p = {}

function p.main()
    local getBuffer, print, printf = newBuffer()
    print('Bemvindo à Wikipédia em Português.')
    printf('Existem atualmente %d artigos neste site.', mw.site.stats.articles)
    return getBuffer(' ')
end

return p