Jump to content

Usuario:Bantoniof

From The Document Foundation Wiki



Visión genérica del código wiki

Introducción

Esta es mi página personal. Aunque no es su propósito, la utilizaré para apuntes de la tradución del formato de la nuestra wiki.
Son una síntesis de las páginas de ayuda en la edición de: MediaWiki (el motor utilizado) y de lo que he ido descubriendo. Pienso que su lectura puede ser útil para los colaboradores de la wiki.
-- Aunque estas directrices son para los editores de páginas, pero es recomendable conocer la estructura de los elementos de la wiki que se encuentran en las traduciones.

A pesar de que el mismo editor de las traducciones nos muestra algunos avisos, no siempre entendemos dónde está el problema.
El conocimiento de esta estructura nos ayuda a detectar y corregir más rápido los errores que podamos tener.
  • En algunas ocasiones se nos olvida escribir o cerrar una etiqueta, o un signo con lo que la página queda desestructurada
  • En otras ocasiones nos ayudamos de un traductor (p.e. google translate) y copiamos y pegamos...
    • Es muy habitual que además del texto nos traduzca las etiquetas o enlaces, ponga espacios donde no debe (creando saltos de línea), o cambie dos comillas sencillas por unas dobles, etc.

Nota: Para entrenarte, puedes hacer pruebas creando y editando tu página personal (a todo usuario se le asigna una página personal que tiene que crear para que aparezca en la Wiki

Normas básicas

Se supone que ya hemos leído las Reglas aplicables en todas las páginas. No se debe olvidar que la traducción de la wiki no es una traducción normal, puesto que aunque aparentemente se visualice como texto normal, se edita texto y partes de código XML
. Por lo que hay que poner un cuidado y atención especial.

  1. Toda etiqueta necesita tener un cierre al final del texto que modifica (p.e <code>Ejemplo</code>) salvo contadas excepciones
  2. Las etiquetas están en inglés y no se deben traducir.
    • Las etiquetas "sueltas" en las traduciones (sin etiqueta de cierre o de inicio) no se completan ni se modifican (caso algo frecuente es la etiqueta <noinclude>)
  3. Los signos de puntuación (o espacios) al inicio de una línea se tienen que respetar y no suelen llevar "cierre" (excepto los títulos).
  4. Se puede ampliar el contenido de una página en cualquier bloque de traducción, aunque se debe evitar a no ser que sea una aclaración suficientemente necesaria y breve.
    • También se puede cambiar el formato de algun elemento porque al redactor de la página se le haya olvidado
-Es muy habitual encontrarse citas a botones y a secuencias de menú en las que no se ha empleado la plantilla correspondiente,
en estos casos está totalmente justificado puesto que mejora la presentación y hace más legible la página.

Formatos de párrafo

Para los títulos se utilizan varios símbolos igual (=) al principio de la línea y debén tener su correspondiente cierre.

  • =Titulo 1= El título 1 no se utiliza en las traducciones por pertenecer al título de la página y sólo debe haber un título 1
  • ==Título 2== El título2 es el segundo nivel de los títulos (aparece subrayado y un poco más pequeño que el título de la página).
  • ===Título 3=== El título 3 es el tercer nivel (aparece en negrita y subrayado).

y así sucesivamente... (los títulos llevan cierre)

* Un párrafo sin formato se crea dejando un espacio o varios antes del texto y aparecerá con el fondo gris 
se suele utilizar para resaltar las aclaraciones

saltos de línea

Los saltos de línea se crean automáticamente cuando se escribe en la siguiente línea del editorde traducción.

  • con la etiqueta <br> entre medias de un texto seguido se crea un salto de línea que parte la línea en la posición de la etiqueta. (no hace falta cerrarla)

Sangrías, listas numeradas y viñetas

Son un caso especial, aparecen al principio de la linea y no necesitan cerrarse

  • Para sangría se utilizan los dos puntos (:), para numeración la almohadilla (#), para viñetas el asterisco (*)

según se repiten estos signos, se aumenta el nivel y viceversa.

  1. Numeración 1 #Numeración 1
  • Viñeta 1 *Viñeta 1
    • Viñeta 2 *Viñeta 2
Sangría 3:::Sangría 3

Formatos de carácter

Formatos de carácter
Visualización Código notas
unos caracteres en Monotipo) unos caracteres en <code>Monotipo</code>
Cursiva ''Cursiva'' (2 comillas Las comillas son siempre sencillas
Negrita '''Negrita''' (3 comillas)
Cursiva Negrita '''''Cursiva Negrita ''''' (5 comillas)
Subrayado <u>Subrayado</u>
tachado <s>tachado</s>
Superíndice Super<sup>índice</sup>
  • Una etiqueta <nowiki>, muestra el código xml tal como se ve y se debe usar en el editor de la wiki,
  • Una etiqueta <pre> que encierra un bloque de texto, lo presenta en Monotipo y con el área en gris, se cierra en la última línea del bloque de texto.

Se utiliza generalmente para presentar un bloque de instrucciones macro o lenguaje de script.

Nota:
Hasta ahora se han visto los signos y etiquetas más usadas. Las siguientes son un más elaboradas

Notas al pie

Una etiqueta y su texto que puede sorprender o confundir es la nota al pié:
las notas al pie utilizan la etiqueta <ref> está mezclada con el texto del párrafo con lo que rómpe el flujo normal de una lectura del texto que estamos traduciendo.
Esto es así y por el momento no se puede cambiar (no hay que olvidar que se está modificando un código XML).

  • El texto normal se debe entender como un texto que se detiene en la etiqueta de apertura <ref> y continúa después de su cierre (</ref>)
  • El texto encerrado entre esas etiquetas es la nota al pie y aparece al final de la página precedida de un número según el orden en la página

Esto es un ejemplo de su código: Este es el texto que aparece en la página<ref>patata patata patata</ref>interferido por la referencia que aparece como nota al pie. [1]

Enlaces

Los enlaces pueden externos (a páginas de fuera de la wiki) o internos (a páginas o documentos de la wiki).
Generalmente, aunque no siempre, los enlaces se encierran entre corchetes, sencillos para direcciones externas [....] o dobles para direcciones internas [[...]]

  • Es preferible que los enlaces no acaben con la barra inclinada (/)
  • La dirección del enlace no lleva espacios (esto es un estándar de HTML)
    • para espacios o caracteres especiales (caracteres con acentos etc.) se emplea una notación especial algo como esto: https%3A%2F%2Fwiki.documentfoundation.org/Planes%20futuros
    • En los enlaces nos podemos encontrar una almohadilla (#) en este caso símbolo se utiliza para dirigir a una sección de la página
Las direcciones web no llevan espacios, tengan o no la almohadilla, va todo seguido.

Enlaces externos

Los enlaces externos no necesitan llevar corchetes pero es recomendable por claridad y porque su uso nos aporta ciertas ventajas (pueden ser más sencillos de leer)

  • Si es escribe la dirección sin corchetes http://wikipedia.com se nos mostrará la dirección web y el simbolito de enlace: http://wikipedia.com
  • Si se escribe solo la dirección entre corchetes no se muestra la dirección. Aparecerá el símbolo del enlace precedido de una numeración según su orden en la página. [1]
  • Si se escribe la dirección entre corchetes, un espacio y se escribe un texto, aparecerá ese texto alternativo y el sçimbolo de enlace. [Http://wikipedia.com páginas de la wikipedia] mostrará: páginas de la wikipedia
    • wikipedia interpreta todo lo que va seguido como La dirección real del sitio web.
    • Al estar entre corchetes, el espacio oculta la dirección , y el texto (que puede llevar espacios y acentos) es lo que mostrará en lugar de la dirección.

Enlaces internos

Los enlaces internos son distintos de los externos y se emplean tanto para un enlace a otra página interna, como para archivos o imágenes que se muestra en la página.
En los enlaces internos se omite la dirección base (wiki.documentfoundation.org) y nuncan deben acabar con la barra inclinada final (/)

  • [[Faq/Base/es]] crea un enlace que nos mostrará el nombre de la página p.e. Faq/Base/es
  • [[Faq/Base/es | Preg. Frecuentes de Base]] Con una barra y después de la dirección un texto será más descriptivo: p.e. Preg. Frecuentes de Base
    • A diferencia del espacio en los enlaces externos, en los internos se usa una barra vertical ( | ) .
    • En los enlaces internos no aparece el simbolito del enlace.
  • Los enlaces a archivos tienen el formato [[File:....]]
  • Siempre que se traduce un enlace a una página interna se debe comprobar si la página existe en español y entonces adjuntar el prefijo /es
* Cuando se enlaza con una página, archivo etc. de la wiki se deben usar enlaces internos

Nota:
Los enlaces internos mal formados o más bien, que no tienen destino, aparecen en la página resaltados con color de letra en rojo.
Actualiza la página después de traducirla y comprueba que no aparecen enlaces en ese color

Imágenes o archivos

Como he indicado son enlaces internos, y no se deben traducir, solo si lleva una leyenda se traducirá la última parte p.e.
En [[File:TextToColumns.gif|frame|center|Using Text to Columns function]] solo se traduce Using Text to Columns function

Plantillas

En la wiki se emplean plantillas que son fragmentos de código ya preparados para incluir en las páginas. Se utilizan en muchas ocasiones. Hay plantillas para:

  • Los menús propios de la wiki, botones, atajos de teclado los avisos, secciones que se repiten en distintas páginas, etc...

para incluir una plantilla se utilizan las llaves dobles, y los parámetros necesarios separados por una barra (obligatoria) {{plantilla | parámetro1 | etc...}}

a continuación se muestran algunas de uso frecuente:

Botones, teclas y secuencias de menús

Aceptar {{Button|Aceptar}}
Ctrl + Mayús + 1 {{Key | Ctrl | Mayús | 1}}
Editar ▸ Selecionar todo {{Bc | Editar | Selecionar todo}}
  • No es necesario dejar espacio entre las barras y los parámetros, pero mejora la identificación de los elementos

Avisos

Note, Tip, y Warning son plantillas para llamar la atención sobre una sugerencia etc... si se ponen tal cual p.e. {{Tip |...}} aparecerá la cabecera en inglés, En marzo de 2022 se crean las plantillas para mostrar la cabecera del mensaje en español, así pues hay que agregar el sufijo /es cuando nos encontremos una plantilla de este tipo

Inglés Español Aviso en español

Note:
una nota

Nota:
una nota

{{ Note/es | una nota}}

Tip:
un consejo

Consejo:
un consejo

{{ Tip/es | un consejo}}

Warning:
una advertencia

Aviso:
una advertencia

{{ Warning/es | una advertencia}}

Otras Plantillas

Resaltado de caracteres
plantilla Label
{{ Label | plantilla Label }}
plantilla Correct {{ Correct | plantilla Correct }}
plantilla Incorrect {{ Incorrect | plantilla Incorrect }}


Código de programación o Macros

En las páginas de macros suele verse el código resaltado como se ve en un editor de código. Normalmente esto no aparece en las traduciones, solo se ven (y traducen) los comentarios.
Como dato curioso, y por si nos encontramos algún fragmento con instrucciones de código, solo se pueden/deben traducir los comentarios.
Para este código se emplea la plantilla <syntaxhighlight lang=".... "> donde lang es el lenguaje de programación (hay varias alternativas) [2]

Cosas que no suelen aparecer en el editor de traducción

Unas cuantas cosas que no suelen aparecer en las traducciones pero puede que alguna vez las encontremos, o pueden ser útiles al editar una página: .

Sumario

Los sumarios normalmente se crean de manera automática, pero también se puede modificar su aspecto o evitar su aparición.

__NO TOC__ Sin sumario
{{ TOC right }} Sumario a la derecha

Tablas

Esta es la manera más habitual de presentar una tabla, pero se pueden formatear de muy diversas maneras: consulta la página relacionada de Mediawiki para más información.

Leyenda
Cabecera A Cabecera B Cabecera C
Celda A1 Celda B1 Celda C1
A2 B2 C2
A3 B3 C3
{| class="wikitable"
|+Leyenda 
|- 
!Cabecera A !! Cabecera B !! Cabecera C
|-
|Celda A1||Celda B1 || Celda C1
|-
|A2 || B2 || C2
|-
|A3 || B3 || C3
|}

Imágenes

Tienes que conocer el nombre del archivo imágen (o subir uno tu mismo) y se puede utilizar como bullet
[[image:star.png]]
[[image:star-005.png | 30px]]
[[image:Padlock.png |50px]]

MIS PRUEBAS

Aquí iré poniendo mis pruebas que puede que comente para que no se muestren.

Tabla con colorines
Título de un capítulo de la ayuda
Orig. Exporting Presentations
👎︎ Exportando presentaciones
👍︎ Exportación de presentaciones
Exportar presentaciones
Acción en proceso
Orig. Printing
👎︎ Impresión
👍︎ Imprimiendo
Impresión en curso


Icono vikipedia
Sumatorio Con icono de enlace normal [ https://es.wikipedia.org/wiki/Sumatorio Sumatorio ]
Sumatorio⁠ Con su icono {{ Wikipedia | language=es | Sumatorio }}

Notas al pie


  1. ↑ patata patata patata