Módulo:Formato texto/doc
Uso
Este módulo define varias funciones útiles sobre texto.
Funciones
enlazar()
Función simple para generar un wikienlace
- Código
enlazar(enlace, texto, calificativo)
- Parámetros
enlace
es el enlace a analizartexto
la etiqueta del enlacecalificativo
un valor opcional, entre paréntesis, con tanaño de fuente más pequeño
enlazar2()
Función compleja para generar un wikinelace o archivo multimedia, y comprobar si el destino existe.
- Código
enlazar(enlace, opciones)
- Parámetros
enlace
string
es el enlace a analizar.opciones
mixed
valor mixto para las opciones, según el tipo de dato:
string
la etiqueta del enlace.number
el espacio de nombres como identificador numérico (el identificador de espacio de nombres para "Archivo:" es6
).nil
la etiqueta será idéntica al enlace (no se suprimirá en el wikitexto resultante por razones técnicas).table
una serie de opciones en una tabla (array) cuyas claves son:
etiqueta
string
la etiqueta del enlace.namespace
number
el espacio de nombres.tamaño
string
el tamaño de la imagen (para espacio de nombres6
), seguido del sufijo 'px'.link
string
un enlace alternativo, para archivos multimedia (espacio de nombres6
).calificativo
string
un texto alternativo, entre paréntesis, con fuente más pequeña para espacios de nombre diferentes de6
.debeExistir
bool
tratar el resultado según la prefrencia de existencia o no del enlace.
true
la función comprueba si el destino existe. De existir, devuelve el wikienlace, de lo contrario, devuelve laetiqueta
. Para el espacio de nombres "Archivo:", siempre se considerarátrue
.false
devuelve el wikienlace indistintamente si existe o no el destino.
entreParentesis()
Función simple para poner texto y un calificativo entre paréntesis
- Código
entreParentesis(texto fuera de los paréntesis, texto dentro de los paréntesis)
- Ejemplos
entreParentesis(Robert de Niro, actor)
→ Robert de Niro (actor)
entreParentesis(Robert de Niro)
→ Robert de Niro
entreParentesis(nil, actor)
→
enCursivas()
enCursivas(texto)
enVariasLineas()
enVariasLineas(tabla)
- Ejemplos
enVariasLineas({'Robert de Niro', 'actor'})
→
- Robert de Niro
actor
enVersalitas()
enVersalitas(texto)