Predefinição:Module rating/doc
Esta é uma subpágina de documentação para a Predefinição:Module rating. Ela contém informações sobre o seu uso, categorias, bem como todo o conteúdo que não faz parte da predefinição original. |
Descrição
Esta predefinição é utilizada para classificar por qualidade os módulos Lua. A predefinição é colocada na parte de cima da subpágina /doc de documentação do módulo, e produz uma mensagem que informa os usuários sobre o sistema de classificação do módulo e o incluiu em uma categoria de monitoramento.
Uso
Uso básico:
Sem categorias:
Se o {{Module rating}}
for utilizado fora do domínio Módulo, aparece uma mensagem de erro como mostrado: Error: {{Module rating}}
must be placed in the Module namespace.
Classificações
A classificação deve ser colocada no primeiro parâmetro posicional. Existem cinco classificações diferentes: pré-alfa, alfa, beta, geral, e protegida. Existem também alias ou códigos de atalhos para cada classificação.
Rating | Alias | Resultado |
---|---|---|
pré-alfa |
prealfa pa |
Error: {{Module rating}} must be placed in the Module namespace.
|
alfa |
a |
Error: {{Module rating}} must be placed in the Module namespace.
|
beta |
b |
Error: {{Module rating}} must be placed in the Module namespace.
|
geral |
release geral g |
Error: {{Module rating}} must be placed in the Module namespace.
|
protegida |
protegido p |
Error: {{Module rating}} must be placed in the Module namespace.
|
Qualquer outro valor ou se está em falta | Error: {{Module rating}} must be placed in the Module namespace.
|
Categorias
Esta predefinição coloca os módulos em uma das seguintes categorias, de acordo com a classificação definida:
- Categoria:!Módulos em desenvolvimento pré-alfa
- Categoria:!Módulos em alfa
- Categoria:!Módulos em beta
- Categoria:!Módulos para uso geral
- Categoria:!Módulos totalmente protegidos
Estas categorias são suprimidas nas páginas que acabam em /doc. Para suprimir categorias em todas as páginas, pode utilizar o parâmetro |nocat=true
.