Module:Transcluder/doc
 | Esta es una subpágina de documentación para «Module:Transcluder/doc». Contiene información de uso, categorías y otros contenidos que no forman parte de la página original de Module. |
Este módulo es un motor de transclusiones genérico, capaz de transcluir cualquier parte de cualquier página y con muchas opciones que las transclusiones normales no ofrecen.
Uso
Módulos
El punto de entrada principal para módulos es el método get.
get( 'Title' )– Obtener la páginas solicitada (idéntico resultado a una transclusión normal)get( 'Title#' )– Obtener la sección introductoria de la página solicitadaget( 'Title#Section' )– Obtener la sección o etiqueta<section>solicitada (incluye subsecciones)
Las etiquetas <noinclude> y <onlyinclude> se procesan de modo ordinario y también existe un segundo parámetro opcional para excluir varios elementos del resultado:
get( 'Title#Section', { files = 0 } )– Excluir todos los archivosget( 'Title#Section', { files = 1 } )– Excluir todos los archivos excepto el primeroget( 'Title#Section', { files = 2 } )– Excluir todos los archivos excepto el segundoget( 'Title#Section', { files = '1,2' } )– Excluir todos los archivos excepto el primero y el segundoget( 'Title#Section', { files = '1-3' } )– Excluir todos los archivos excepto el primero, segundo y terceroget( 'Title#Section', { files = '1,3-5' } )– Excluir todos los archivos excepto el primero, tercero, cuarto y quintoget( 'Title#Section', { files = -2 } )– Excluir el segundo archivoget( 'Title#Section', { files = '-2,3' } )– Excluir el segundo y tercer archivosget( 'Title#Section', { files = '-1,3-5' } )– Excluir el primer, tercer, cuarto y quinto archivosget( 'Title#Section', { files = 'A.png' } )– Excluir todos los archivos excepto A.pngget( 'Title#Section', { files = '-A.png' } )– Excluir A.pngget( 'Title#Section', { files = 'A.png, B.jpg, C.gif' } )– Excluir todos los archivos excepto A.png, B.jpg y C.gifget( 'Title#Section', { files = '-A.png, B.jpg, C.gif' } )– Excluir A.png, B.jpg y C.gifget( 'Title#Section', { files = { [1] = true, [3] = true } } )– Excluir todos los archivos excepto el primero y terceroget( 'Title#Section', { files = { [1] = false, [3] = false } } )– Excluir el primer y tercer archivoget( 'Title#Section', { files = { ['A.png'] = false, ['B.jpg'] = false } } )– Excluir A.png y B.jpgget( 'Title#Section', { files = '.+%.png' } )– Excluir todos los archivos excepto los archivos PNG (véase patrones Lua)get( 'Title#Section', { files = '-.+%.png' } )– Excluir todos los archivos PNG
La misma sintaxis se puede utilizar para excluir muchos otros elementos:
get( 'Title#Section', { sections = 0 } )– Excluir todas las subseccionesget( 'Title#Section', { sections = 'History, Causes' } )– Excluir todas las subsecciones excepto 'History' y 'Causes'get( 'Title#Section', { lists = 1 } )– Excluir todas las listas excepto la primeraget( 'Title#Section', { tables = 'stats' } )– Excluir todas las tablas excepto la que tiene id 'stats'get( 'Title#Section', { paragraphs = '1-3' } )– Excluir todos los párrafos excepto el primero, segundo y terceroget( 'Title#Section', { references = 0 } )– Excluir todas las referenciasget( 'Title#Section', { categories = '0' } )– Excluir todas las categoríasget( 'Title#Section', { templates = '-.+infobox' } )– Excluir las plantillas de infoboxesget( 'Title#Section', { parameters = 'image' } )– Excluir todos los parámetros de todas las plantillas excepto el parámetro 'image'
Las opciones se pueden combinar a voluntad. Por ejemplo:
get( 'Title#Section', { sections = 0, files = 1, paragraphs = '1-3' } )– Excluir todas las subsecciones, todos los archivos excepto el primero y todos los párrafos excepto los primeros tres.
También puedes obtener solo algunos elementos así:
get( 'Title#Section', { only = 'files' } )– Obtener solo los archivosget( 'Title#Section', { only = 'lists', lists = 1 } )– Obtener solo la primera listaget( 'Title#Section', { only = 'tables', tables = 'stats' } )– Obtener solo la tabla con id 'stats'get( 'Title#Section', { only = 'paragraphs', paragraphs = '1,3-5' } )– Obtener solo el primer, tercer, cuarto y quinto párrafosget( 'Title#Section', { only = 'templates', templates = 'Infobox' } )– Obtener solo la infoboxget( 'Title#Section', { only = 'parameters', parameters = 'abstract', references = 0 } )– Obtener solo el parámetro llamado 'abstract' y quitar todas las referencias del mismo
El resultado también se puede modificar con unas pocas opciones especiales:
get( 'Title#Section', { noFollow = true } )– No seguir redireccionesget( 'Title#Section', { linkBold = true } )– Enlazar el título en negritas o su sinónimo cerca del comienzo del textoget( 'Title#Section', { noBold = true } )– Quitar el texto en negritasget( 'Title#Section', { noComments = true } )– Quitar comentariosget( 'Title#Section', { noLinks = true } )– Quitar todos los enlacesget( 'Title#Section', { noSelfLinks = true } )– Quitar los enlaces al artículo transclusorget( 'Title#Section', { noNonFreeFiles = true } )– Quitar archivos no libres (identificados por tener las palabras 'non-free' en su descripción local o en Commons)get( 'Title#Section', { noBehaviorSwitches = true } )– Quitar las opciones de comportamiento como__NOTOC__get( 'Title#Section', { fixReferences = true } )– Rescatar referencias definidas fuera de la sección solicitada y prefijar los nombres de las referencias con 'Título ' para evitar conflictos en los nombres de las referencias
Además del método get, el módulo expone varios otros métodos para obtener partes específicas del wikitexto.
Esto permite a otros módulos combinar los elementos de maneras más avanzadas.
Plantillas
El principal punto de entrada para plantillas es el método main.
Esencialmente es un envoltorio del método get para que sea utilizable en plantillas.
Véase la documentación del método get para más detalles y opciones.
{{#invoke:Transcluder|main|Title}}– Transcluir la página solicitada{{#invoke:Transcluder|main|Title#}}– Transcluir la sección introductoria de la página solicitada{{#invoke:Transcluder|main|Title#Section}}– Transcluir la sección o etiqueta<section>solicitada (incluye subsecciones){{#invoke:Transcluder|main|Title#Section|sections=0}}– Transcluir la sección solicitada, excluyendo subsecciones{{#invoke:Transcluder|main|Title|only=files|files=1}}– Transcluir solo el primer archivo de la página{{#invoke:Transcluder|main|Title#Section|only=tables|tables=2}}– Transcluir solo la segunda tabla de la sección solicitada{{#invoke:Transcluder|main|Title#|only=paragraphs|linkBold=yes}}– Transcluir solo los párrafos de la sección introductoria y enlazar el texto en negritas