Ayuda:Ayuda
De GuiaMigraciones
Contenido |
Ayuda de la Guía de Migraciones
Este artículo pretende servir de introducción a la estructura y uso de la wiki en guia.migramos.org.
Qué es y qué NO es esta Wiki
En primer lugar, aclarar la finalidad de este wiki.
- Queremos disponer de una referencia general para llevar a cabo de manera planificada y lo mas optimizada posible un proyecto de migración, concretamente destinado a organismos y entidades públicas.
- Este wiki no pretende en ningún caso ser una base de conocimientos con todas las incidencias posibles surgidas en el proceso de migración, dado que en primer lugar un wiki no es el medio adecuado para ello, y por otra parte el existen otras herramientas destinadas a ese fin, como GLPI.
- Se quiere dar una imagen completa y exhaustiva de todos los pasos y fases de un proyecto de migración, basándonos en el proyecto realizado en la Axarquía, y se intentará en todo momento mantener un punto de vista genérico, que pueda ser fácilmente adaptado a cada caso.
- Sin embargo, no podemos pretender dar soluciones concretas a todos los posibles escenarios de migración que puedan surgir, dado que cada proyecto tendrá sus características inherentes que lo diferenciarán del resto.
Indicaciones para la creación de páginas
Tanto para facilitar el mantenimiento de la página, como para evitar posibles problemas, se recomienda seguir estas indicaciones, las cuales pretenden servir para dar un poco de homogeneidad a la Wiki, pero que en ningún caso son normas inviolables, y deberán ajustarse en función de las necesidades concretas:
- Los títulos de las páginas no deben contener espacios ni tildes. MediaWiki no tiene ningún problema en usar estos caracteres (de hecho, la página principal) tiene espacios y tildes), pero de cara al mantenimiento de los enlaces y la base de datos es recomendable evitar su uso. Además, los visitantes de países no hispanohablantes pueden tener problemas para generar ciertos caracteres de forma cómoda.
- En el caso de los espacios, remplazarlos por el carácter _ (guión bajo). Esto no afecta a la presentación del título de la página, dado que MediaWiki traduce de manera directa y automática este carácter por el espacio.
- Respecto al uso de tildes, simplemente sustituir el carácter con tilde por su equivalente sin tilde.
- Las letras especiales, como la ñ pueden suponer un problema especial para visitantes extranjeros. Considerar su uso en cada caso adecuadamente.
- Ejemplo: la página Virtualización de Aplicaciones tendría como título recomendado Virtualizacion_de_Aplicaciones, evitando los espacios y la tilde sobre la letra o.
- Para facilitar el uso, cada página debe contener en la parte inferior la barra de navegación. Dicha barra se obtiene mediante el código {{Plantilla:Navegacion}} (ver Plantillas), siempre al final de la página.
- En aquellas páginas que formen parte de un proceso ordenado, se deben incluir debajo de la barra de navegación enlaces al punto anterior y posterior del proceso
- Un enlace a la anterior etapa del proceso, de la siguiente forma [[ENLACE_AL_ARTICULO_ANTERIOR|< TEXTO DEL ENLACE ]]. El texto ira precedido de un signo < (menor que).
- Un enlace a la siguiente etapa del proceso, de la siguiente forma [[ENLACE_AL_ARTICULO_SIGUIENTE|TEXTO DEL ENLACE >]]. El texto seguido de un signo > (mayor que).
- En la medida de lo posible el texto de los enlaces debe ser descriptivo del contenido, pero se ruega evitar textos excesivamente largos para evitar que se corte en resoluciones de pantalla pequeñas.
- Ejemplo:
[[Ejecucion_del_Inventariado|< Ejecución del Inventariado]] - [[Pruebas_Tecnicas|Pruebas Técnicas >]]
Para esto, podemos utilizar las #Plantillas, en concreto la de caja, que mejora la presentación.
Estructura de las páginas
Para facilitar la homogeneidad de la guía, se recomienda que las páginas de proceso sigan siempre la misma estructura.
Paginas de proceso
- Tabla de contenidos
- Título largo de la pagina, como sección de nivel 1
- Objetivo del proceso, como sección de nivel 2, seguido de un texto explicativo breve
- Listado de los procedimientos a seguir, como sección de nivel 2, mediante esquema de viñetas de mediawiki. Es recomendable incluir una pequeña introducción de una o dos líneas.
- Cada procedimiento, como sección de nivel 1, con las siguientes partes:
- Nombre del Proceso y su resumen, como sección de nivel 2.
- Justificación del mismo, como sección de nivel 2.
- Objetivos a lograr, como sección de nivel 2.
- Cada objetivo se indica como elemento de un esquema de viñetas.
- Requerimientos del proceso, como sección de nivel 2, mediante esquema de viñetas.
- Descripción exahustiva del proceso, como sección de nivel 2, lo más completa posible.
- Procedimiento completo y ordenado para llevar a cabo el proceso, mediante esquema con los pasos ya sea numerado o con viñetas. En caso necesario, y siempre que redunde en una mayor claridad, estos pasos pueden llevar a su vez a otras páginas del wiki que expliquen en detalle el paso concreto. Esto se deberá hacer para los procesos con pasos muy largos o complejos (por ejemplo, en la ejecución del inventariado, algunos puntos requieren páginas aparte, como son la configuración o uso del sistema de inventariado mediante Inventory Libre).
- Resumen de cualquier dato previo que se requiera para llevar a cabo el proceso, como sección de nivel 1. Cada dato, como esquema de viñetas.
- Incidencias genéricas y habituales que puedan surgir en el proceso, y la forma de evitarlas, como sección de nivel 1 El grado de detalle dependerá de cada situación, pero se reitera que el wiki no debe ni puede ser una base de conocimientos de todas las casuísticas.
- Conclusiones del proceso, como sección de nivel 1. Deberán aclararse los resultados que deben obtenerse y aquellas comprobaciones que sean necesarias para pasar al siguiente proceso.
- Plantilla:
__TOC__
= Nombre Proceso =
== Objetivo de esta fase ==
...
== Procedimientos ==
...
* Proc1
* Proc2
= Procedimiento 1 =
== Resumen ==
...
=== Justificacion ===
...
=== Objetivos ===
*...
**...
*...
**...
=== Requerimientos del sistema ===
*Req1
*Req2
=== Descripción del sistema ===
=== Procedimiento de uso ===
*ProcUso1
*ProcUso2
= Datos previos requeridos =
*Req
= Incidencias habituales =
...
= Conclusiones de esta fase =
{{Navegacion}}
Sección especal: Glosario
El Glosario está pensado especialmente para la sección pública de la wiki. En el mismo deberán aparecer definiciones breves y claras de los términos empleados, pero no debe convertirse en un diccionario completo de Software Libre. En caso de necesitar incluir una definición muy extensa, se debe considerar la posibilidad de crear una página especialmente dedicada al concepto, e incluir en la entrada correspondiente del glosario un enlace a dicha página. De igual modo, se acepta el uso de enlaces externos a otras páginas que puedan aclarar mejor el concepto.
Plantillas
Para facilitar el uso de la guía, se han creado una serie de plantillas para utilizar en los documentos.
Caja
Esta plantilla genera una caja que sirve para destacar un texto. Se usa de la forma: {{caja|texto a mostar}} y genera lo siguiente:
Ejemplo de uso de la plantilla caja
Aviso
Esta plantilla funciona de la misma forma que caja, pero destaca en color rojo y añade de forma automática la palabra advertencia al comienzo de la caja. Se usa mediante {{aviso|texto a mostar}} y genera lo siguiente:
ADVERTENCIA: Ejemplo de un aviso
Navegación
La plantilla de navegación genera la caja con la navegación de la guía. Se usa de la siguiente forma: {{Plantilla:Navegacion}} y genera:
Cita Web
Para hacer referencia a documentos en la web, se dispone de esta plantilla. Permite incluir URL, Título, Autor, Fecha, Formato y Editorial (para los casos donde el material haya sido publicado). Los campos obligatorios son Autor y URL. El resto de campos no aparecen si no se especifican (excepto el formato, que en caso de omisión aparece como HTML), aunque se recomienda completar todos los posibles. Los campos pueden aparecer en cualquier orden, la plantilla los ordena automáticamente. Ejemplo de uso:
{{cita_web
|url = http://www.free-culture.cc/freeculture.pdf
|titulo = Free Culture
|autor = Lessig, Lawrence
|fecha = 2004
|formato = PDF
|editorial = New York: Penguin Press.
}}
genera:
- Lessig, Lawrence. Free Culture. PDF - 2004 - New York: Penguin Press.
Otro ejemplo usando sólo autor y url. Se puede observar que el resto de campos se ignoran.
{{cita_web
|url = https://guia.migramos.org
|autor = Guia.migramos.org
}}
- Guia.migramos.org. https://guia.migramos.org. HTML - -
Ayuda: Primeros pasos con MediaWiki
La principal ventaja de la Wiki es su posibilidad de edición por cualquier usuario (siempre que tenga los permisos adecuados). La sintaxis empleada es muy sencilla, y tanto en las páginas del proyecto MediaWiki como mediante consultas por Internet es sencillo encontrar tutoriales y guías al respecto. No obstante, aquí se incluyen unas nociones básicas que resultarán suficientes para las necesidades de esta guía. También puedes consultar la seccion de plantillas en esta misma página.
Secciones
Toda página del Wiki debe tener las secciones correctamente definidas. Las secciones sirven para dividir y organizar el documento, y pueden crearse secciones con niveles.
Para crear una sección, en una nueva línea se colocan signos igual ("=") rodeando el título de la sección. Las secciones de primer nivel emplean un sólo signo igual, las de segundo dos, y así sucesivamente.
Por ejemplo, = TITULO = es una sección de primer nivel, mientras que == TITULO == es una de segundo nivel. El nivel de las secciones define el número que se les asigna en la tabla de contenidos, mientras que el texto de las mismas sirve para realizar enlaces dentro de la propia página y de esta forma hacer referencia directa a la sección.
Tablas de Contenido
Cada página debería contener siempre la tabla de contenido (TOC, Table Of Contents), que facilita la navegación por la misma. MediaWiki crea la TOC de forma automática en aquellos artículos con más de 4 secciones. No obstante, puede forzarse o evitarse su aparición de manera individual para cada página, independientemente del número de secciónes.
- Para forzar su aparición, se debe incluir el comando __TOC__ en la página, preferiblemente en la primera línea de la misma. Notar que hay dos guiones bajos (_) antes y despues de TOC.
- Para evitar que aparezca, se debe incluir el comando __NOTOC__ en la página, preferiblemente en la primera línea de la misma. Notar que hay dos guiones bajos (_) antes y despues de NOTOC.
En algunas páginas (Por ejemplo, en el Glosario), aunque la tabla de contenidos es imprescindible, la versión predeterminada de MediaWiki resulta muy incómoda (aparece una columna vertical muy larga). En este caso se ha optado por evitar la aparición del TOC predeterminado, para crear de manera manual y estática un TOC propio para dicha página.
Enlaces
En MediaWiki se dispone de diversos enlaces, pero por lo general se usarán 3 tipos:
Enlaces internos a otras páginas
Un vínvulo interno se crea de la siguiente forma: [[TITULO_DE_LA_PAGINA|TEXTO DEL ENLACE]]. Notar que el enlace y el texto se separan mediante un carácter Pleca o raya vertical. El texto puede usar expacios y caracteres con tilde. Por ejemplo, un enlace a la portada sería: [[Portada|Portada a la guía]] y generaría el enlace Portada a la guía. Notar que este enlace no tiene ningún símbolo que lo identifique
Enlaces internos en la misma página
De forma predeterminada, las diferentes secciones de una página se pueden emplear como enlaces internos, para permitir el acceso directo a las mismas (tal y como hace la tabla de contenidos). Para crear un enlace de este tipo, se debe usar la sintaxis [[#NOMBRE DE LA SECCION|TEXTO DEL ENLACE]]. Por ejempo, un enlace a la sección de uso de los prefijos al comienzo de esta página sería [[#Uso de los prefijos|Prefijos]], y generaría el enlace Prefijos. Notar que, en caso de no usar el texto a mostrar ([[#Uso de los prefijos]] el símbolo almohadilla aparece delante del enlace para indicar que se trata de un enlace dentro de la misma página.
Enlaces externos a la página
Para estos casos se emplea el formato [http://www.PAGINAWEB.com TEXTO A MOSTRAR]. Es importante no olvidar el http://, o el enlace no funcionará correctamente. Notar también que a diferencia de los otros enlaces, se emplea solamente un corchete de apertura ("[")y otro de cierre ("]").
En caso de querer poner solo la dirección Web, sin texto alternativo, no es necesario ponerlo entre corchetes, pues la dirección se reconoce directamente como un enlace y aparece como tal al mostrar la página.
Por ejemplo, [http://www.emergya.es/ Consultoría Emergya] aparece como Consultoría Emergya, mientras que http://www.emergya.es/ aparece como http://www.emergya.es/.
Este tipo de enlaces aparecen con una marca al final del mismo, en forma de flecha saliendo de un cuadrado, para indicar que se trata de un enlace externo.
Formato de caracteres
- Cursiva: se rodea el texto con dos comillas simples (''TEXTO''), obteniendo esto.
- Negrita: se rodea el texto con tres comillas simples ('''TEXTO'''), obteniendo esto.
- Negrita y cursiva: se rodea el texto con cinco comillas simples ('''''TEXTO'''''), obteniendo esto.
Listas numeradas y viñetas
Para crear una lista numerada, al comienzo de la línea se pone el carácter almohadilla (#), seguido del texto. Para que la numeración sea continua, las líneas que se vayan a numerar tienen que ir seguidas, sin líneas en blanco entre ellas. Para poner numeración de segundo nivel y superiores, se deben añadir más caracteres almohadilla (##).
Por ejemplo:
- Nivel 1
- Nivel 1.1
- Nivel 2
- Nivel 2.1
- Nivel 2.1.1
- Nivel 2.1
Archivos e imágenes
MediaWiki permite almacenar archivos en su propia base de datos. Cuando se haga uso de esta funcionalidad, tener en cuenta las condiciones de licencia del mismo, y asegurar de antemano que se permite hacer una redistribución del material en cuestión.
Para incluir archivos en MediaWiki, se emplea la página especial para subida de archivos. Al acceder a la misma, se solicita la ruta al fichero original, el nombre con el cual se desea almacenar en MediaWiki, y la descripción del mismo. Es posible que no se permita almacenar determinados tipos de ficheros. Esto se regula en los ficheros de configuración de MediaWiki, y sólo puede hacerlo un administrador del sitio. Si encuentras que un fichero concreto no puede subirse, comprueba en primer lugar que se trata de uno de los formatos soportados, y en caso de problemas contacta con los responsables en AÑADIR ENLACE AL CORREO GENERAL DE SOPORTE DEL EQUIPO DE MIGRACIONES.
Actualmente los tipos permitidos son: jpg, gif, png, pdf, txt, odt, ods.
Una vez que un fichero está subido a MediaWiki, puedes incluirlo mediante enlaces de MediaWiki usando el nombre con el cual lo has almacenado: [[Archivo:nombre_del_fichero.extension]]
Texto sin formato
En ocasiones deseamos evitar que MediaWiki interprete el texto que escribimos (por ejemplo, en el caso de escribir código fuente). Podemos lograrlo de dos formas:
- Usando <nowiki>texto sin formato</nowiki>
- Usando <pre>texto sin formato</pre>
La diferencia es que la primera, nowiki, elimina los saltos de línea, mientras que pre los respeta.
Licencias y uso correcto de las fuentes de información
Dada la naturaleza de la información contenida en la wiki, es fundamental aclarar la licencia de uso de los contenidos, así como que se se considera un uso correcto de la información, especialmente en lo concerniente a información extraída de sitios externos.
Licencia escogida
El Wiki se ampara en la licencia Creative Commons BY-SA 3.0. Consulte la página sobre derechos de autor del wiki para más información.
Uso de información de terceros sitios
Si se emplea información de páginas externas a la wiki, se debe comprobar siempre la licencia de cada sitio externo, y garantizar la compatibilidad entre dicha licencia y la propia de este Wiki. Bajo ningún concepto se deben copiar informaciones de lugares cuya licencia no sea compatible. Ante estas situaciones, se debe optar por:
- Incluir únicamente un enlace al sitio.
- Crear contenido alternativo de forma propia y original. Importante:si la licencia que protege al contenido externo no permite la creación de obras derivadas, no podrá emplearse dicho contenido como base para generar la información a incluir en la Guía de Migraciones.
- Solicitar permiso expreso al autor original para emplear el contenido concreto. Este permiso se deberá obtener de forma expresa por y para cada contenido con anterioridad al uso del mismo en este wiki. En el permiso se deberá indicar claramente la finalidad, que es el uso en este wiki.
Reiterar, en este último caso, que la autorización para emplear un contenido concreto no supone autorización para cualquier otro contenido del mismo sitio. En caso necesario, se puede intentar conseguir una autorización para emplear contenidos de todo el sitio pero, dada la naturaleza cambiante de la web y sus continuas actualizaciones, siempre será preferible tener autorizaciones concretas sobre contenidos concretos.
En caso de terceros sitios con licencias libres completamente compatibles, es aceptable el uso de la información.
En cualquier caso, siempre se deberá indicar la fuente de la información obtenida de terceros sitios, sea cual sea la licencia que la ampare. De este modo se reconoce en cada momento la autoría del contenido, y se facilita el acceso a la fuente original en caso de necesidad.
Inclusión de material en otros formatos
En algunos puntos de la wiki será necesario incluir información no textual (programas, código fuente, paquetes...). Como norma general, el formato de fichero subido siempre deberá ser libre (por ejemplo, documentos de OpenOffice.org, y sólo en casos excepcionales se debe subir material en formatos propietarios (como el formato de fichero nativo de Microsoft Word). Siempre deberá aclararse de antemano la licencia del contenido, e indicarla en el contenido subido o enlazado. Podemos encontrar dos situaciones:
- Contenido almacenado dentro de la propia wiki, mediante el mecanismo de almacenamiento de ficheros de MediaWiki. En estos casos, y con el fin de evitar problemas de cualquier tipo, sólo se admitirán contenidos libres, bajo licencia igual o completamente compatible con la empleada aquí. También se permite incluir material que se encuentre amparado bajo el dominio público, o para el que se tenga permiso expreso de los autores y licenciatarios para su uso en guia.migramos.org
- Contenido almacenado en lugar externo y enlazado dentro de la wiki: se deberá dejar constancia clara del tipo de licencia del contenido. En este aspecto, y siempre que la licencia del material no lo prohíba expresamente, puede enlazarse contenido bajo cualquier tipo de licencia, dejando constancia expresa de la misma. Tener en cuenta que enlazar un contenido no garantiza que se pueda utilizar en todas las circunstancias. Un ejemplo real: nada impide enlazar a la web de la versión gratuita del antivirus AVG, pero su licencia prohíbe expresamente su uso comercial, por lo tanto poner un enlace en esta wiki (de licencia libre) no nos autoriza a emplearlo para una actuación comercial.
Bajo ninguna circunstancia se permite incluir material para el que su licencia exprese específicamente la prohibición de distribuir el mismo (tal y como software propietario, o material protegido por derechos de autor restrictivos). Siempre que no se tenga claro el tipo de licencia de un material, de debe optar por consultar con los responsables de guia.migramos.org, con el autor original del material, o descartar su uso en el MediaWiki.
Consideraciones adicionales
- Nunca se debe incluir contenido que se sabe no cumple la licencia del MediaWiki. En caso de que dicha información sea obligatoriamente necesaria, enlazar al sitio original.
- Por raro que parezca, la licencia FDL y la licencia GPL NO SON COMPATIBLES. No se puede incluir código protegido por GPL en un documento amparado bajo FDL, dado que el código publicado en el documento quedaría relicenciado bajo la licencia FDL, lo que supone una violación de los términos de GPL. En casos donde sea necesario incluir código, se debe hacer creando enlaces a los ficheros fuente necesarios, indicando siempre que se encuentran protegidos por la GPL.
- No hacer uso de marcas comerciales sin autorización, salvo que su utilización se pueda considerar sin ánimo de duda amparada por el derecho de cita o similares (como, en el caso de la jurisprudencia norteamericana, el uso razonable)
Inglés
