Usuario:Veron.schenone/Experiencias en Wikipedia/Documentación

Introducción

editar

Se presenta aquí, la documentación del tutorial "Experiencias en Wikipedia" y las principales herramientas que fueron utilizadas para su desarrollo. Se espera que ello facilite el mantenimiento y perfeccionamiento del mismo.

Fueron creadas, originalmente, en código HTML y CSS.

Posteriormente, fueron reemplazadas por plantillas (o pseudo plantillas).


Notas al lector

editar

Una de las notas principales, utilizada en el tutorial:

Aclaración


No se pretende reemplazar las amplias referencias que contiene Wikipedia sobre su uso; sino reforzar o experimentar, sobre la comprensión de sus contenidos. El artículo está en proceso de elaboración. Actualmente, está alojado en una subpágina de usuario. Finalizadas las tareas pendientes, podría formar parte de Wikipedia:Tutoriales_informales y, por el tipo de contenido que se espera alcanzar, también de Wikilibros. Cabe aclarar que los artículos de la Wikipedia siempre estarán en un proceso de progreso o perfeccionamiento, nunca en uno de finalización (al menos, eso es lo deseable).


El código resumido:

{{Usuario:Veron.schenone/Plantillas/NotaEditores
|estado = lector
|Texto de la advertencia
}}


Notas a los posibles editores

editar

Se llama a la plantilla de la siguiente forma:

{{Usuario:Veron.schenone/Plantillas/NotaEditores
|estado = 2
|texto = Narración o relación de algo. Dependencia o semejanza de algo respecto de otra cosa. Base o apoyo de una afirmación
}}

Resultado:

Estado: Intermedio.
Narración o relación de algo. Dependencia o semejanza de algo respecto de otra cosa. Base o apoyo de una afirmación

Parámetro "estado", valores:

a) "lector", para las advertencias dirigidas a los lectores); y

b) "1", "2" o "3", para indicar a los editores los estados de adelantamiento, de menor a mayor -Inicial, Intermedio o Avanzado-, de la cuestión o el tema. Por defecto u omisión, si no se escribe éste parámetro, será 3 (Avanzado)".


Parámetro "texto":

a) Contenido de una nota al lector, para llamar su atención sobre algo (Advertencia), hacerle notar u observar alguna cosa; o

b) Indicar a los editores lo que se requiere (Narración o relación de algo. Dependencia o semejanza de algo respecto de otra cosa. Base o apoyo de una afirmación).


Para una mayor especificación, se puede puede leer la documentación de la plantilla.


Representación de código

editar

Originalmente, para la representación de código, se había optado por la utilización de la etiqueta <syntaxhighlight lang="text"></syntaxhighlight> (Véase "Contador de funciones costosas del analizador" de la siguiente tabla).

Tiempo de uso de CPU 0,266 segundos
Tiempo real de uso 0,310 segundos
N.º de nodos visitados por el preprocesador 4629/1 000 000
Tamaño de inclusión posexpansión 83 057/2 097 152 bytes
Tamaño de los parámetros de plantilla 9659/2 097 152 bytes
Profundidad máxima de expansión 12/100
Contador de funciones costosas del analizador 39/500
Profundidad de recursión de función «unstrip» 1/20
Tamaño tras la expansión de «unstrip» 83 604/5 000 000 bytes
Tiempo de uso de Lua 0,061/10,000 segundos
Uso de memoria de Lua 3 368 121/52 428 800 bytes
Número de entidades de Wikibase cargadas 0/400

Al advertirse el costo que insumía para el sistema (se desconocía que tuviera una injerencia similar a determinadas variables o funciones "mágicas"), fue reemplazada por el siguiente código:

<code style="padding: 1em; display: block;"><nowiki>

Codigo informático

</nowiki></code>

Se agregaron los atributos de estilo CSS inline, para que, visualmente, sea muy similar a la representación de texto, a través de la etiqueta <syntaxhighlight>.

El resultado:

Tiempo de uso de CPU 0,337 segundos
Tiempo real de uso 0,385 segundos
N.º de nodos visitados por el preprocesador 4633/1 000 000
Tamaño de inclusión posexpansión 83 519/2 097 152 bytes
Tamaño de los parámetros de plantilla 9592/2 097 152 bytes
Profundidad máxima de expansión 12/100
Contador de funciones costosas del analizador 5/500
Profundidad de recursión de función «unstrip» 1/20
Tamaño tras la expansión de «unstrip» 77 908/5 000 000 bytes
Tiempo de uso de Lua 0,077/10,000 segundos
Uso de memoria de Lua 3 300 049/52 428 800 bytes
Número de entidades de Wikibase cargadas 0/400


Separación de contenido

editar

Aclaración


Actualmente se está evaluando su necesidad. Existieron cambios en el sistema y, hasta donde se pudo observar, luego de una etiqueta <div>, se agregaría, automáticamente, uno o dos párrafos (se han advertido ambas situaciones) que contienen una etiqueta <br>. Del siguiente modo: "<p><br></p>" o "<p><br></p><p><br></p>". Ello anula la funcionalidad (y plantea dudas sobre la utilidad) de esta plantilla (aparece un espacio mucho mayor al establecido).
Podría ser reemplazada por <div></div>.

<!-- Plantilla Separar -->
{{Usuario:Veron.schenone/Plantillas/Separar
|separado = chico
}}

La plantilla separa o interrumpe el contenido de texto que, por alguna razón (pasaje del editor de código al visual y viceversa, por ejemplo), había sido establecido y "desaparece" o se "re-ubica".

A la variable o parámetro "separado", se le pueden asignar los siguientes valores: "grande" (1.5em); "mediano" (1.25em) o "chico" (1em).

También posibilita separar el contenido de un elemento "flotante" (con el parámetro "limpiarFlotantes" y la asignación "= si"). En la documentación de la plantilla se ejemplifica lo indicado.

Es conveniente agregar el comentario "<!-- Plantilla: Separar -->", para poder localizar su ubicación y el contenido que genera, en el editor visual (pues no muestra contenido y mantiene el fondo —propiedad "background-color" de CSS— del elemento padre).

<!-- Plantilla Separar -->
{{Usuario:Veron.schenone/Plantillas/Separar
|separado = mediano
|limpiarFlotantes = si
}}

Para obtener mayor información sobre su uso, puede dirigirse a la documentación de esta plantilla.


Botón al índice de contenido

editar

Se realiza mediante la llamada a la plantilla "botonEnlace".

El código del botón es el siguiente:

{{Usuario:Veron.schenone/Plantillas/botonEnlace}}

Para obtener mayor información sobre su uso, puede dirigirse a la documentación de esta plantilla.


Indice del contenido

editar

Aclaración


En resoluciones de pantalla menores a 720px (y conexión a través de un dispositivo móvil), la clase CSS ".toc" que lo contiene, posee la propiedad "display: none;" (el índice, no se visualiza). Solo en resoluciones iguales o mayores a 720px, la propiedad se establece en "display: table;" (visualizándose el mismo). Se ha buscado una la alternativa.


El código de la alternativa, plantilla "{{Usuario:Veron.schenone/Plantillas/Contenido}}":

<div id="Indice" style="display: table; padding: 0.4375em; border: 1px solid #a2a9b1; background-color: #f8f9fa; max-width: 98%; margin-right:auto; font-size: 95%;">
<p>Contenido:</p>
*[[{{{URLrel}}}#Introducci%C3%B3n|Introducción]]
*[[{{{URLrel}}}#Cap%C3%ADtulo%5FI%3A%5FLo%5Fb%C3%A1sico|Capítulo I: Lo básico]] 
*#[[{{{URLrel}}}#1%2E%5FLa%5Fsintaxis%5Fdel%5F%22Wikitexto%22|La sintaxis del "Wikitexto"]]
*##[[{{{URLrel}}}#1%2E1%5FFirma%5Fen%5Flos%5Fcomentarios%5Fy%5Fsolicitudes|Firma en los comentarios y solicitudes]]
*##[[{{{URLrel}}}#1%2E2%5FEstilo%5Fde%5Ffuente%5Fpara%5Fun%5Ftexto|Estilo de fuente para un texto]]
*##[[{{{URLrel}}}#1%2E3%5FFormato%5Fde%5Fsecci%C3%B3n|Formato de sección]]
*##[[{{{URLrel}}}#1%2E4%5FListas%5Fde%5Fdescripci%C3%B3n|Listas de descripción]]
*##[[{{{URLrel}}}#1%2E5%5FListas%5Fordenadas|Listas ordenadas]]
*##[[{{{URLrel}}}#1%2E6%5FListas%5Fdesordenadas|Listas desordenadas]]
*##[[{{{URLrel}}}#1%2E7%5FSaltos%5Fde%5Fl%C3%ADnea|Saltos de línea]]
*##[[{{{URLrel}}}#1%2E8%5FTexto%5Fcon%5Fsangr%C3%ADa|Texto con sangría]]
*##[[{{{URLrel}}}#1%2E9%5FEtiquetas%5Fde%5FWikitexto|Etiquetas de Wikitexto]]
*##[[{{{URLrel}}}#1%2E10%5FEtiquetas%5FHTML|Etiquetas HTML]]
*[[{{{URLrel}}}#Cap%C3%ADtulo%5FII%3A%5FTemas%5Fcomunes|Capítulo II: Temas comunes]] 
*#[[{{{URLrel}}}#1%2E%5FPlantillas|Plantillas]]
*##[[{{{URLrel}}}#1%2E1%5FFormas%5Fde%5Fuso%5Fen%5Flas%5Fp%C3%A1ginas|Formas de uso en las páginas]]
*##[[{{{URLrel}}}#1%2E2%5FEstructuras%5Fde%5Fcontrol|Estructuras de control]]
*##[[{{{URLrel}}}#1%2E3%5FUso%5Fde%5Fhojas%5Fde%5Festilo%5FCSS|Uso de hojas de estilo CSS]]
*#[[{{{URLrel}}}#2%2E%5FNotas%5Fen%5Fla%5Fetapa%5Fde%5Finicio%2C%5Fdesarrollo%5Fy%5Frevisi%C3%B3n|Notas en la etapa de inicio, desarrollo y revisión]]
*#[[{{{URLrel}}}#3%2E%5FPersonalizar%5Fla%5Fpropia%5Finterfaz|Personalizar la propia interfaz]]
*##[[{{{URLrel}}}#3%2E1%5FPasos|Pasos]]
*[[{{{URLrel}}}#Cap%C3%ADtulo%5FIII%3A%5FP%C3%A1gina%5Fde%5Fusuario|Capítulo III: Página de usuario]] 
*#[[{{{URLrel}}}#1%2E%5FProblemas%2C%5Fdudas%5Fo%5Finquietudes%5Fy%5Fposibles%5Fsoluciones|Problemas, dudas o inquietudes y posibles soluciones]]
*##[[{{{URLrel}}}#1%2E1%5FAlternativas%5Fpara%5Fel%5Fuso%5Fde%5Falgunas%5Fplantillas|Alternativas para el uso de algunas plantillas]]
*###[[{{{URLrel}}}#1%2E1%2E1%5FContador|Contador]]
*##[[{{{URLrel}}}#1%2E2%5FVisualizaci%C3%B3n%5Fde%5Fun%5Faviso%5Fsobre%5F%22P%C3%A1gina%5Fde%5Fusuario%22|Visualización de un aviso sobre "Página de usuario"]]
*#[[{{{URLrel}}}#2%2E%5FC%C3%B3digos%5Fy%5Frepresentaci%C3%B3n|Códigos y representación]]
*##[[{{{URLrel}}}#2%2E1%5FUserboxtop|Userboxtop]]
*[[{{{URLrel}}}#Cap%C3%ADtulo%5FIV%3A%5FArt%C3%ADculos|Capítulo IV: Artículos]] 
*#[[{{{URLrel}}}#1%2E%5FInvestigaci%C3%B3n|Investigación]]
*#[[{{{URLrel}}}#2%2E%5FAutores|Autores]]
*#[[{{{URLrel}}}#3%2E%5FProblemas%2C%5Fdudas%5Fo%5Finquietudes%5Fy%5Fsoluciones|Problemas, dudas o inquietudes y soluciones]]
*##[[{{{URLrel}}}#3%2E1%5FCategor%C3%ADas|Categorías]]
*##[[{{{URLrel}}}#3%2E2%5FRegla%5Fde%5Flas%5Ftres%5Freversiones|Regla de las tres reversiones]]
*##[[{{{URLrel}}}#3%2E3%5FConflictos%5Fde%5Fedici%C3%B3n%2E%5F%C2%BFC%C3%B3mo%5Fevitarlos%3F%2E|Conflictos de edición. ¿Cómo evitarlos?.]]
*##[[{{{URLrel}}}#3%2E4%5FLas%5Freferencias%5Fy%5Fnotas%5Fal%5Fpie%5Fen%5Flos%5Fart%C3%ADculos|Las referencias y notas al pie en los artículos]]
*[[{{{URLrel}}}#Cap%C3%ADtulo%5FV%3A%5FDudas%2C%5Finquietudes%5Fy%5Fproblemas%2C%5Fno%5Fmencionados|Capítulo V: Dudas, inquietudes y problemas, no mencionados]]
*[[{{{URLrel}}}#Cap%C3%ADtulo%5FVI%3A%5FBibliograf%C3%ADa|Capítulo VI: Bibliografía]]
*[[{{{URLrel}}}#Cap%C3%ADtulo%5FVII%3A%5FNotas|Capítulo VII: Notas]]
*[[{{{URLrel}}}#Cap%C3%ADtulo%5FVIII%3A%5FReferencias|Capítulo VIII: Referencias]]
*[[{{{URLrel}}}#Cap%C3%ADtulo%5FIX%3A%5FEnlaces%5Fexternos|Capítulo IX: Enlaces externos]]
*[[{{{URLrel}}}#Cap%C3%ADtulo%5FX%3A%5FDocumentaci%C3%B3n|Capítulo X: Documentación]]
</div>
<noinclude>{{Documentación}}</noinclude>

La plantilla sólo reemplaza una URL relativa (algo sencillo pero muy útil, cuando el contenido es muy extenso).


Para clasificar la información, se ha establecido la siguiente unidad jerárquica:

  • Capítulo I (en números romanos, equivalente a Título)
    1. Apartado (equivalente a Subtítulo 1)
      1. Punto (equivalente a Subtítulo 2)
        1. Punto (equivalente a Subtítulo 3)
          1. Punto (equivalente a Subtítulo 4)


Se lee:


Capítulo I, apartado 1.1.1


Y, cuando el contenido buscado, tiene una jerarquía menor:

Capítulo I, apartado 1, punto 1


Se utiliza una lista desordenada, para indicar los capítulos y una lista ordenada, para los elementos de menor jerarquía.

* [[{{{URLrel}}}#Capítulo II: Temas comunes|Capítulo II: Temas comunes]]
*# [[{{{URLrel}}}#1. Plantillas|Plantillas]]
*## [[{{{URLrel}}}#1.1 Formas de uso en las páginas|Formas de uso en las páginas]]
*### [[{{{URLrel}}}#1.2.1 Algunos ejemplos|Algunos ejemplos]]
*#### [[{{{URLrel}}}#1.2.1.1 Función "if"|Función "if"]]


En el título o subtítulo del cuerpo del texto, el número precedente se debe agregar manualmente. En la plantilla, se copiará ese título (con el número incluído) en la URL relativa (a diferencia del ejemplo, debe ser codificada, se explicará más adelante). Y el título del tema (que se representará en la lista al inciio del tutorial) se agrega sin el número precedente (la lista ordenada se encarga de hacerlo automáticamente).

Cualquier cambio en los títulos o subtítulos en el cuerpo del texto, debe reflejarse en la plantilla (caso contrario, la URL no funcionará, pues la redirección al destino, ha cambiado).

Se transcribe (o "transcluye") la documentación, donde se explica la necesidad de codificar la URL relativa.



Plantilla creada para exhibir un índice de contenido y facilitar su modificación.
Código Resultado
<!-- Esquema representativo del código de la plantilla -->

*[[{{{URLrel}}}#T%C3%ADtulo|Título]]
*#[[{{{URLrel}}}#Subt%C3%ADt1|Subtít1]]
*##[[{{{URLrel}}}#Subt%C3%ADt2|Subtít2]]
*###[[{{{URLrel}}}#Subt%C3%ADt3|Subtít3]]
*####[[{{{URLrel}}}#Subt%C3%ADt4|Subtít4]]
<!-- Código de llamada a la plantilla -->

{{Usuario:Veron.schenone/Plantillas/Contenido
|URLrel = Usuario:nombre_de_usuario/Proyecto
}}
Aclaraciones:

1°) Sobre las URL relativas: Inicialmente, se había planteado utilizar la variable "mágica" {{ARTICLEPAGENAME}}, para agregar automáticamente las URL. Sin embargo, cuando la cantidad de líneas es numerosa, se sobrecargaría el sistema.

2°) Las direcciones URL, solo se deben enviar al navegador, utilizando el conjunto de caracteres ASCII. Sin embargo, suelen contener caracteres que se encuentran fuera de este conjunto. La codificación de URL, reemplaza esos caracteres por un signo "%", seguido de dos dígitos hexadecimales. Las direcciones URL tampoco deben contener espacios en blanco. Éstos suelen ser reemplazados por "%20". El intérprete de MediaWiki, los reemplaza por guiones bajos "_". En la codificación utilizada en el ejemplo, también se reemplazan éstos caracteres. También aquí se podrían haber utilizado las variables "mágicas" {{urlencode:...|WIKI}} (reemplaza los caracteres en blanco por guiones bajos) y {{urlencode:...|PATH}} (letras con tildes y reemplazo de otros caracteres problemáticos); pero frente a un elevado número de líneas, también se sobrecargaría el sistema.


Template data

editar

Reemplaza la URL relativa en un índice de contenido.

Parámetros de la plantilla

ParámetroDescripciónTipoEstado
URLrelURLrel

URL relativa del documento (se prescinde de las partes: protocolo, nombre del servidor y parte de la ruta del recurso enlazado). Sólo se requiere del espacio de nombres y el nombre del documento.

Ejemplo
Usuario:nombre_de_usuario/Proyecto
Contenidoobligatorio

Representación de etiquetas y descripción

editar
<code>&lt;nowiki&gt;&lt;/nowiki&gt;</code>— Esta etiqueta, ...

Se busca la estandarización: "<code><etiqueta></etiqueta></code>—" (finaliza en una raya o guión largo). Es decir, ajustar todas esas representaciones de etiquetas y significado, a lo indicado.


Modelo de las tablas utilizadas

editar
Resumen de ...
Marcado Representación Nota
Item1 Representación del Item1 Nota Item1
Item2 Representación del Item2 Nota Item 2
Item3 Representación del Item3 Nota Item3
{| class="wikitable" style="font-size:94%; width:min-content; border-spacing: 0.125em; margin:auto; border-collapse:collapse!important;"<!-- Debería tomar "border-collapse" -> Ver -->
|+Resumen de ...
! style="background-color:#b8e6ce" |Marcado
! style="background-color:#b8e6ce" |Representación
! style="background-color:#b8e6ce" |Nota
|-
| style="text-align:center;" |Item1
|Representación del Item1
|Nota Item1
|-
| style="text-align:center;" |Item2
|Representación del Item2
|Nota Item 2
|-
| style="text-align:center;" |Item3
|Representación del Item3
|Nota Item3
|}
<div style="clear:both;"></div>
En algunos casos, se especifica el ancho y otras propiedades del contenido, en medidas relativas. La adaptación a las tablas a un contenido adaptable es favorable para la visualización en dispositivos móviles. Sin embargo, la adaptación que se realizan en algunas a un ancho específico, debe ser corregida por algún voluntario con conocimientos sobre el tema (posibles errores en el uso de las etiquetas <div> y <span>).

Notas al pie

editar

El esquema elegido es el siguiente:

Texto que precede a la primer nota. [nota 1]

Texto que precede a la segunda nota. [nota 2]

  1. Este es el texto del contenido de la primera nota.[1]
  2. Este es el texto del contenido de la segunda nota.

Texto que precede a la primer nota. [nota 1]

Texto que precede a la segunda nota. [nota 2]

Aclaración


Se han detectado errores, al agregar enlaces en las referencias. Ciertos caracteres que los contienen, parecen ser los responsables de los mismos.


  1. Este es el texto del contenido de la primera nota.[2]
  2. Este es el texto del contenido de la segunda nota.


Referencias

editar
  1. Este es el texto de la primera nota, que aparecerá en las referencias.
  2. Este es el texto de la primera nota, que aparecerá en las referencias.