Diferencia entre revisiones de «Ayuda:Manual de estilo»

De Guía Ubuntu
Saltar a: navegación, buscar
(Las capturas de pantalla)
(He intentado actualizar y ordenar lo ya puesto..)
Línea 1: Línea 1:
{{Nota|'''A todos los colaboradores:''' Por favor, no copiéis y peguéis el contenido de la antigua guía en esta. Queremos hacer una cosa nueva, con más y mejor contenido.}}
+
Algunas recomendaciones o directrices generales para participar en esta guía:
  
__TOC__
+
== Nuevas páginas ==
  
== Introducción ==
+
*A la hora de comentar las bondades de una determinada aplicación, la aportación debería tener estos apartados:
  
Hemos visto que habéis empezado a añadir contenidos a esta nueva guía de Dapper. Antes de nada nos gustaría daros unas directrices sobre cómo añadir información:
+
#Descripción y captura de pantalla
 +
##Requisitos
 +
##Características
 +
##Enlaces externos
 +
#Proceso de instalación
 +
#Configuración
 +
#Posibles problemas
  
* El título principal de la página ya viene puesto, por lo que las secciones irán como titulares de nivel 2 (Con dos signos de igual rodeando el nombre del título). Un atajo es pulsar sobre el botón con la letra A grande de la barra de edición.
+
*Siempre que se pueda '''no copiar literalmente artículos''' de las versiones antiguas de esta guía o de otras fuentes y revisarlo, corregir errores o faltas ortográficas, ampliadlo, etc
  
* Ahora ya no va a ser una colección de ¿Cómo instalar...?  ya que la inmensa mayoría de las veces se limita a un '''aptitude install pepito'''. Ahora las sección deberían tener el nombre del programa o una cadenas más explícita. También habría que explicar un poco sobre el programa e idealmente una captura de pantalla.  
+
*'''Categorizar''' siempre, el título de la nueva página debe de ser lo mas sencillo posible.
  
* Los programas que ya vienen instalados por defecto en Ubuntu no hace falta explicar como se instalan.
+
*Intentad no repetir procesos similares como la instalaciones de programas, haciendo una referencia como por ejemplo al apartado [[añadir aplicaciones]] donde se explican los diversos métodos de instalación que existen.
  
* Para instalaciones normales de programas que ya se encuentran en los repositorios, en lugar de poner la consabida línea '''$sudo aptitude install pepito''' hacer una referencia al apartado [[Primeros pasos/Añadir aplicaciones]] donde se explican los diversos métodos de instalación que existen.
+
*Siempre que sea posible utilizar una interfaz gráfica en vez de usar el Terminal o Consola, por ejemplo nombrar ''Añadir y quitar..'' para instalar aplicaciones y no ''$sudo aptitude install programa".
  
== Añadir nuevos puntos ==
+
== Ediciones ==
  
No más entradas del estilo ''¿Cómo instalar...?''. La anterior guía se estaba convirtiendo en una acumulación de instrucciones de instalación que, por lo general, aportaban muy poca información al usuario. Las entradas cuya única información era un:
+
* En el campo '''Resumen''' que sale en la parte inferior de la página cuando se entra en modo edición, se debe de notificar el tipo de modificación realizada para mejorar la organización entre todos.
  
<pre>
+
* Usar siempre el botón ''Previsualizar'' antes de pulsar ''Grabar la página'' para evitar estar editando reiteradamente y sobrecargar el servidor.
$ sudo aptitude install pepito
+
</pre>
+
  
ya no deben existir. Se especificará el nombre del paquete y un enlace a la página dónde se explica, de forma única, como instalar programas en Ubuntu ([[Primeros pasos/Añadir aplicaciones]]). Así no forzamos a utilizar una consola y la gente puede usar una aplicación gráfica para estos menesteres como es '''Synaptic'''. Tampoco tiene ningún sentido explicar como instalar aplicaciones que ya vienen por defecto instaladas en Ubuntu Dapper.  
+
* Si no estamos seguros de qué hemos modificado en área de texto, con el botón '''Mostrar cambios''' se verá una lista con las diferencias entre la página original y nuestra modificación.
  
En la portada hay un índice que categoriza la información que hay en el wiki:
+
== Autorías ==
 +
 
 +
* Los administradores pensamos que '''los usuarios tienen derecho a firmar sus aportaciones''' si lo desean aunque: '''el hecho de no firmar una aportación no la hace anónima, ya que el historial aparece el autor y su colaboración'''.
 +
 
 +
* Respetar las licencias posibles de un artículo si se copia o se modifica levemente.
 +
 
 +
== Imágenes ==
 +
 
 +
* Se recomienda adjuntar siempre alguna captura de pantalla. Para ello puede usarse la aplicación ''Capturar pantalla'' del panel de GNOME por ejemplo. El nombre de la imagen debe de ser claro y concreto.
 +
 
 +
* Para intentar mantener una homogeneidad se aconseja usar el siguiente formato genérico:
 +
 
 +
<pre>[[Imagen:Nombredelaimagen.jpg|thumb|Breve descripción de la captura]]</pre>
 +
 
 +
* Si se usa este formato estándar, para que la vista previa (''thumb'') se vea de forma óptima es preferible usar el formato [[w:es:JPG]] antes que otros como el [[w:es:PNG]]. Con ''The GIMP'' puedes editar de distintas maneras cualquier tipo de imagen.
 +
 
 +
* Para que las imágenes no ''invadan'' la sección siguiente prueba con añadir en modo edición y justo antes de la sección ''invadida'':
 +
 
 +
<pre><br style="clear:both;"></pre>
 +
 
 +
* Si se desean añadir muchas capturas de pantalla, se puede usar este formato para todas las imágenes que se desee:
 +
 
 +
<pre><gallery>
 +
[[Imagen:Nombredelaimagen1.jpg|Breve descripción de la captura1]]
 +
[[Imagen:Nombredelaimagen2.jpg|Breve descripción de la captura2]]
 +
</gallery></pre>
 +
 
 +
== Estructura de la guía ==
 +
 
 +
{{Nota|Se debe de notificar la modificación de la Portada o alguna parte importante de la guía a los '''[[Usuario:Admin|administradores]]'''}}
 +
 
 +
*Este es un índice general de categorías que puede resultar útil para organizar los artículos del wiki:
  
 
<div style="background-color:#c1f0e3; margin:0 auto 0 auto; width:75%; align: center;padding:5px">
 
<div style="background-color:#c1f0e3; margin:0 auto 0 auto; width:75%; align: center;padding:5px">
 
# Instalación
 
# Instalación
## Descarga
 
## Actualización desde Breezy
 
## Instalación limpia
 
 
# Primeros pasos
 
# Primeros pasos
## Activar universe-multiverse
 
## Añadir aplicaciones
 
## Multimedia - Instalar codecs
 
## Instalar la impresora
 
 
# Usuario doméstico
 
# Usuario doméstico
 
## Personalizar el entorno
 
## Personalizar el entorno
Línea 45: Línea 73:
 
## Internet
 
## Internet
 
## Juegos
 
## Juegos
## Migración desde Windows
+
## Relacionado con Windows
## Interoperabilidad con Windows
+
## Xgl
+
 
# Administración del sistema
 
# Administración del sistema
 
## Escritorios remotos
 
## Escritorios remotos
## Optimización
+
## Optimizar
## Securización
+
## Securidad
### Actualización de paquetes
+
### Desactivación de servicios
+
### Cortafuegos
+
 
## Recuperación de desastres
 
## Recuperación de desastres
## Instalación de software
+
## Añadir servicios
### Servidor web
+
## Redes locales
### Servidor de correo
+
### Servidor de FTP
+
## Compartición de ficheros e impresoras en red
+
 
# Conoce tu sistema
 
# Conoce tu sistema
## Los procesos
 
## El arranque
 
## Sistema de ficheros
 
## Configuración de red
 
 
# Programación  
 
# Programación  
 
</div>
 
</div>
 
Cualquier aportación que añadamos iría dentro de alguna de las categorías o puntos. Tendrás que editar la portada para añadir el enlace a la página en la que vas a añadir la aportación. Cada aportación nueva irá en una página individual. En la otra guía había muchos puntos en algunas páginas y era lento de ver.
 
 
<div style="border:2px solid #f7cc00;background-color:#f7d899; margin:0 auto 0 auto; width:75%; align: center;padding:5px">
 
'''Estas categorías principales no se deberán modificar sin consultar previamente con algunos de los [[Usuario:Admin|administradores de la guía]]'''
 
</div>
 
 
A la hora de comentar las bondades de una determinada aplicación, la aportación debería tener estos apartados:
 
 
* Descripción de la aplicación
 
** Comentar características de la misma
 
** Paquete que tenemos que instalar y/o proceso de instalación si lo requiere
 
** Captura de pantalla con el tema por defecto de Ubuntu Dapper (por homogeneidad)
 
* Configuración
 
** Alguna cosa que debamos saber sobre la configuración
 
** Características que deberíamos tener habilitadas por defecto
 
 
== Actualizando el cambio ==
 
 
En el campo '''Resumen''' puedes escribir una breve descripción de la modificación. Teniendo en cuenta que somos muchos lo que estamos viendo y modificando las páginas del wiki constantemente, es muy buena idea rellenar siempre este campo que se mostrará en el historial de la página. Asi de un vistazo vemos que ha pasado entre una versión y otra de la página.
 
 
En la página de edición tenemos debajo del área de texto editable unos botones y controles. Con el botón '''Grabar la página''' envías la modificación al servidor y está visible para el resto del mundo casi instantáneamente. Por ello siempre antes de enviar los cambios hay que previsualizar lo que hemos editado para comprobar que todo está bien escrito y tiene el aspecto correcto. El botón '''Mostrar previsualización''' se encarga de esto.
 
 
Si no estamos seguros de qué hemos modificado en área de texto, con el botón '''Mostrar cambios''' se verá una lista con las diferencias entre la página original y nuestra modificación.
 
 
== El controvertido tema de las firmas ==
 
 
En estos momentos veo que hay un pequeño lío sobre el tema de firmar aportaciones. Mucha gente cree que no se deben firmar. No se si por tratarse de una norma de la Wikipedia, ya que ,en un principio, la página de ayuda en la edición de esta guía era la misma que la de la Wikipedia. Esto supongo que es debeido a que si un artículo tiene muchas modificaciones por parte de varias personas, al final habrá un montón de firmas. Y no queda muy bonito que haya más firma que texto :)
 
 
Esto ha desembocado en usuarios que borran las firmas de otros y el consiguiente malestar de los firmantes que se quejan del extraño anonimato al que se quiere llevar esto. Los administradores pensamos que los usuarios tienen derecho a firmar sus aportaciones si lo desean. También queremos aclarar que '''el hecho de no firmar una aportación no la hace anónima, ya que el historial aparecen todas las modificaciones''' hechas a una página junto con su autor. Pero insistimos en que si alguien lo desea, puede firmar explícitamente.
 
 
 
== Las capturas de pantalla ==
 
 
Siempre es recomentable que el artículo tenga una captura del pantalla de la aplicación sobre la que se escribe. Para capturar sólo la venta del programa basta con pulsar la tecla ''Alt + Imprimir Pantalla''. El nombre del fichero en cuestión será solamente el nombre de la aplicación sin la palabra ''Pantallazo'' que pone programa que realiza las capturas.
 
 
Para evitar líos sobre el tamaño con el que aparecen las capturas en los artículos, lo mejor es decirle que sean del tipo muestra (thumbnail en inglés, aunque la abreviatura ''thumb'' también es válida). Este es un parámetro global de la configuración del Wiki y asegura que todas tendrán el mismo tamaño. El formato de la inclusión de la imagen será el siguiente:
 
 
<pre>
 
[[Imagen:NombreAplicacion.jpg|thumbnail|right|Breve descripción de la captura.]]
 
</pre>
 
 
Hay que prestar atención a los mensajes que da el wiki a la hora de subir las imágenes. Por defecto, la aplicación de capturas de pantalla guarda las imágenes en formato PNG. Es preferible usar imágenes en formato JPG por lo que tendrás que convertirlas usando algún programa con el Gimp. La abres con Gimp y le das a la opción ''Guardar como...'' y le cambias la extensión '''.png''' por '''.jpg'''. Si en la aplicación de captura cambias la extensión no la cambiará de formato: será un imagen con formato PNG con extensión '''.jpg'''.
 
 
{{Nota|Aunque ocupen algunas veces un poco más, es preferible usar las imágenes en formato JPG ya que las imágenes de muestra (thumnail) tiene mayor calidad.}}
 
 
Para que las imágenes no invadan la sección siguiente prueba con:
 
 
<pre>
 
<br style="clear:both;">
 
</pre>
 

Revisión de 17:57 6 ago 2006

Algunas recomendaciones o directrices generales para participar en esta guía:

Nuevas páginas

  • A la hora de comentar las bondades de una determinada aplicación, la aportación debería tener estos apartados:
  1. Descripción y captura de pantalla
    1. Requisitos
    2. Características
    3. Enlaces externos
  2. Proceso de instalación
  3. Configuración
  4. Posibles problemas
  • Siempre que se pueda no copiar literalmente artículos de las versiones antiguas de esta guía o de otras fuentes y revisarlo, corregir errores o faltas ortográficas, ampliadlo, etc
  • Categorizar siempre, el título de la nueva página debe de ser lo mas sencillo posible.
  • Intentad no repetir procesos similares como la instalaciones de programas, haciendo una referencia como por ejemplo al apartado añadir aplicaciones donde se explican los diversos métodos de instalación que existen.
  • Siempre que sea posible utilizar una interfaz gráfica en vez de usar el Terminal o Consola, por ejemplo nombrar Añadir y quitar.. para instalar aplicaciones y no $sudo aptitude install programa".

Ediciones

  • En el campo Resumen que sale en la parte inferior de la página cuando se entra en modo edición, se debe de notificar el tipo de modificación realizada para mejorar la organización entre todos.
  • Usar siempre el botón Previsualizar antes de pulsar Grabar la página para evitar estar editando reiteradamente y sobrecargar el servidor.
  • Si no estamos seguros de qué hemos modificado en área de texto, con el botón Mostrar cambios se verá una lista con las diferencias entre la página original y nuestra modificación.

Autorías

  • Los administradores pensamos que los usuarios tienen derecho a firmar sus aportaciones si lo desean aunque: el hecho de no firmar una aportación no la hace anónima, ya que el historial aparece el autor y su colaboración.
  • Respetar las licencias posibles de un artículo si se copia o se modifica levemente.

Imágenes

  • Se recomienda adjuntar siempre alguna captura de pantalla. Para ello puede usarse la aplicación Capturar pantalla del panel de GNOME por ejemplo. El nombre de la imagen debe de ser claro y concreto.
  • Para intentar mantener una homogeneidad se aconseja usar el siguiente formato genérico:
[[Imagen:Nombredelaimagen.jpg|thumb|Breve descripción de la captura]]
  • Si se usa este formato estándar, para que la vista previa (thumb) se vea de forma óptima es preferible usar el formato w:es:JPG antes que otros como el w:es:PNG. Con The GIMP puedes editar de distintas maneras cualquier tipo de imagen.
  • Para que las imágenes no invadan la sección siguiente prueba con añadir en modo edición y justo antes de la sección invadida:
<br style="clear:both;">
  • Si se desean añadir muchas capturas de pantalla, se puede usar este formato para todas las imágenes que se desee:
<gallery>
[[Imagen:Nombredelaimagen1.jpg|Breve descripción de la captura1]]
[[Imagen:Nombredelaimagen2.jpg|Breve descripción de la captura2]]
</gallery>

Estructura de la guía

Nota clasica.png Se debe de notificar la modificación de la Portada o alguna parte importante de la guía a los administradores
  • Este es un índice general de categorías que puede resultar útil para organizar los artículos del wiki:
  1. Instalación
  2. Primeros pasos
  3. Usuario doméstico
    1. Personalizar el entorno
    2. Accesorios
    3. Ofimática
    4. Video
    5. Audio
    6. Internet
    7. Juegos
    8. Relacionado con Windows
  4. Administración del sistema
    1. Escritorios remotos
    2. Optimizar
    3. Securidad
    4. Recuperación de desastres
    5. Añadir servicios
    6. Redes locales
  5. Conoce tu sistema
  6. Programación