Diferencia entre revisiones de «Ayuda:Manual de estilo»

De Guía Ubuntu
Saltar a: navegación, buscar
(Añadir nuevos puntos)
(Imágenes)
 
(No se muestran 27 ediciones intermedias realizadas por 6 usuarios)
Línea 1: Línea 1:
<div style="border-bottom:4px solid #f7cc00;border-right:4px solid #f7cc00;background-color:#f7d899; margin:0 auto 0 auto; width:75%; align: center;padding:5px">
+
Algunas recomendaciones o directrices generales para participar en esta guía:
'''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
+
</div>
+
  
== Introducción ==
+
== Nuevas páginas ==
  
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:
+
* A la hora de comentar las bondades de una determinada aplicación o un aspecto del sistema operativo, la aportación debería tener estos apartados:
  
* 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.
+
# Descripción y captura de pantalla
 +
## Requisitos
 +
## Características
 +
# Proceso de instalación
 +
# Configuración
 +
# Posibles problemas
 +
# Ver también
 +
# Enlaces externos
  
* 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.  
+
* 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, ampliarlo, etc. Y añadir la fuente en '''Enlaces externos'''.  
  
* Los programas que ya vienen instalados por defecto en Ubuntu no hace falta explicar como se instalan.
+
* '''Categorizar''' siempre. El título de la nueva página debe de ser lo más sencillo posible.
  
* 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.
+
* 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.  
  
== Añadir nuevos puntos ==
+
* Siempre que sea posible utilizar una {{w|interfaz gráfica de usuario|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''.Piensa también en que puedes ampliar el artículo aportando ambas combinaciones.
  
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:
+
== Ediciones ==
  
<pre>
+
* 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.
$ 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.  
+
* Usar siempre el botón «''Previsualizar''» antes de pulsar «''Grabar la página''» para evitar estar editando reiteradamente y sobrecargar el servidor.
  
En la portada hay un índice que categoriza la información que hay en el wiki:
+
* Si no estamos seguros de qué hemos modificado en el á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 '''no se deben firmar los artículos''', porque consideramos que es una falta de respeto al resto de los colaboradores. Todas las colaboraciones quedan reflejadas junto con su autor en el historial del artículo. Puedes ver más información al respecto en la [[Guía Ubuntu:Políticas|política de Guía Ubuntu]] '''[[Guía Ubuntu:Acerca de firmar artículos|«Acerca de firmar artículos»]]'''.
 +
 
 +
* Respetar las {{w|licencia de software|licencias}} posibles de un artículo si se copia o se modifica levemente. Esto implica que no debe agregarse contenido con {{w|derecho de autor}}.
 +
 
 +
== Imágenes ==
 +
 
 +
* Se recomienda adjuntar siempre alguna captura de pantalla en los artículos. Para ello puede usarse la aplicación «''Capturar pantalla''» de GNOME (''gnome-screenshot'') o KDE (''ksnapshot''), 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:Nombre de la imagen.extensión|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|JPG}} antes que otros como el {{w|PNG}}. Con [[GIMP]], por ejemplo, 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>
 +
 
 +
=== Convenciones de nombres ===
 +
 
 +
Para conocer las convenciones de nombres para las imágenes, ver [[Guía Ubuntu:Convenciones de títulos#Imágenes|Convenciones de títulos -> Imágenes]].
 +
 
 +
== Estructura de la guía ==
 +
 
 +
{{Nota|Se debe notificar la modificación de la Portada o alguna parte importante de la guía a los '''[[Guía Ubuntu:Administradores|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
 
 
## Accesorios
 
## Accesorios
## Ofimática
 
## Video
 
## Audio
 
 
## Internet
 
## Internet
 +
## Interoperabilidad con Windows
 
## Juegos
 
## Juegos
 
## Migración desde Windows
 
## Migración desde Windows
## Interoperabilidad con Windows
+
## Multimedia
## Xgl
+
### Audio
 +
### Vídeo
 +
## Ofimática
 +
## Personalizar el entorno
 
# Administración del sistema
 
# Administración del sistema
 
## Escritorios remotos
 
## Escritorios remotos
## Optimización
+
## Optimizar
## Securización
+
## Seguridad
### 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.
+
== Enlaces a la Wikipedia ==
  
<div style="border-bottom:4px solid #f7cc00;border-right:4px solid #f7cc00;background-color:#f7d899; margin:0 auto 0 auto; width:75%; align: center;padding:5px">
+
Para hacer enlaces a artículos de la Wikipedia, se debe utilizar la '''[[Plantilla:W|plantilla W]]''', en lugar del enlace común de MediaWiki. Para más ayuda sobre cómo usar esta plantilla, ver [[Plantilla:W/uso|esta página]].
'''Estas categorías iniciales 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:
+
La plantilla brinda las siguientes ventajas frente al modo de enlace de MediaWiki:
 +
* Disminución de la cantidad de txto requerido para crear el enlace. Por ejemplo, si quisiéramos hacer un enlace al artículo Linux de la Wikipedia, escribiríamos con MediaWiki:
 +
<pre>[[w:es:Linux|Linux]]</pre>
 +
Mientras que con esta plantilla sólo escribiríamos:
 +
<pre>{{w|Linux}}</pre>
 +
* Seguimiento de todos los artículos que enlazan a la Wikipedia. Para hacerlo, esta plantilla añade los artículos en los que se usa a la categoría [[:Categoría:Artículos que enlazan a la Wikipedia|Artículos que enlazan a la Wikipedia]].
  
* Descripción de la aplicación
+
[[Categoría:Ayuda]]
** 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
+

Última revisión de 13:16 14 ene 2008

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 o un aspecto del sistema operativo, la aportación debería tener estos apartados:
  1. Descripción y captura de pantalla
    1. Requisitos
    2. Características
  2. Proceso de instalación
  3. Configuración
  4. Posibles problemas
  5. Ver también
  6. Enlaces externos
  • 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, ampliarlo, etc. Y añadir la fuente en Enlaces externos.
  • Categorizar siempre. El título de la nueva página debe de ser lo más 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.Piensa también en que puedes ampliar el artículo aportando ambas combinaciones.

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 el á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 no se deben firmar los artículos, porque consideramos que es una falta de respeto al resto de los colaboradores. Todas las colaboraciones quedan reflejadas junto con su autor en el historial del artículo. Puedes ver más información al respecto en la política de Guía Ubuntu «Acerca de firmar artículos».
  • Respetar las licencias posibles de un artículo si se copia o se modifica levemente. Esto implica que no debe agregarse contenido con derecho de autor.

Imágenes

  • Se recomienda adjuntar siempre alguna captura de pantalla en los artículos. Para ello puede usarse la aplicación «Capturar pantalla» de GNOME (gnome-screenshot) o KDE (ksnapshot), 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:Nombre de la imagen.extensión|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 JPG antes que otros como el PNG. Con GIMP, por ejemplo, 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>

Convenciones de nombres

Para conocer las convenciones de nombres para las imágenes, ver Convenciones de títulos -> Imágenes.

Estructura de la guía

Nota clasica.png Se debe 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. Accesorios
    2. Internet
    3. Interoperabilidad con Windows
    4. Juegos
    5. Migración desde Windows
    6. Multimedia
      1. Audio
      2. Vídeo
    7. Ofimática
    8. Personalizar el entorno
  4. Administración del sistema
    1. Escritorios remotos
    2. Optimizar
    3. Seguridad
    4. Recuperación de desastres
    5. Añadir servicios
    6. Redes locales
  5. Conoce tu sistema
  6. Programación

Enlaces a la Wikipedia

Para hacer enlaces a artículos de la Wikipedia, se debe utilizar la plantilla W, en lugar del enlace común de MediaWiki. Para más ayuda sobre cómo usar esta plantilla, ver esta página.

La plantilla brinda las siguientes ventajas frente al modo de enlace de MediaWiki:

  • Disminución de la cantidad de txto requerido para crear el enlace. Por ejemplo, si quisiéramos hacer un enlace al artículo Linux de la Wikipedia, escribiríamos con MediaWiki:
[[w:es:Linux|Linux]]

Mientras que con esta plantilla sólo escribiríamos:

{{w|Linux}}
  • Seguimiento de todos los artículos que enlazan a la Wikipedia. Para hacerlo, esta plantilla añade los artículos en los que se usa a la categoría Artículos que enlazan a la Wikipedia.