Reglas/Wiki Style

De Wiki de la Comunidad Mandriva

Reglas de Estilo del Wiki de Mandriva Linux

Hay una definida necesidad de coherencia cuando un número de personas están editando documentos junto con otros y esta política describe los medios requeridos de edición de este wiki. También describe las diferentes plantillas y estilos que puede y debería usar, y cuando debería usarlos. Discuta la jerarquía y esquema del wiki, la precisión de la edición general, y otra información importante.

Si quiere ser considerado una fuente valiosa para mantener y editar documentos en este wiki, y no una persona molesta, ¡es necesario leer esta página! Todos tienen su propio estilo personal. Vemos esto en como se escriben correos, en como se comentan archivos spec, y en como las notas eran escritas en el antiguo TWiki. ¡Valoramos el estilo personal! Habiendo dicho eso, cuando tiene que ver con mantener un conjunto de documentos que cualquiera puede escribir y un montón de gente puede leer, la consistencia hace el aspecto más profesional. También resultará en menos desorden, menos contenido complicado, menos frustración, y una "experiencia" de trabajo placentera.

Si usted no es capaz o no está dispuesto a seguir los puntos escritos en esta política, le pedimos respetuosamente que se abstenga de editar cualquier documento de este wiki.

Aún cuando este wiki está aun en proceso de configuración, todos los elementos en la política que figura debajo se consideran términos absolutos. Las discusiones para aprobar y finalizar la política tienen que desarrollarse en la lista de correo web-discuss

Tabla de contenidos

[esconder]

[editar] Modificando páginas

Escriba un resumen (resumen de edición) en el pequeño campo debajo del cuadro de edición. Puede usted usar abreviaturas para describir sus cambios, como se describe en el resumen de edición.

[editar] Previsualizar antes de grabar

Cuando haya finalizado, haga clic en el botón Mostrar previsualización para ver cómo sus cambios se verán antes de que los haga permanentes. Repita el proceso de editar/previsualizar hasta que esté satisfecho, luego haga clic en Grabar la página y sus cambios se aplicarán inmediatamente al artículo.

[editar] Firme sus comentarios en las páginas de discusión

En las páginas de discusión, por favor firme sus comentarios escribiendo cuatro tildes (sebelk 11:29, 8 December 2006 (MST)).

Debería usted firmar sus comentarios en las páginas de discusión:

  • Tres tildes (~~~) da su nombre de usuario: Sergio Belkin
  • Cuatro tildes (~~~~) da su nombre de usuario más la fecha y hora Sergio Belkin 07:46, 2 November 2005 (UTC)
  • Cinco tildes (~~~~~) da la fecha/hora sóla: 07:46, 27 November 2005 (UTC)

[editar] Diseño de temas

El diseño de temas, jerarquía de tópicos, es muy importante. Todo debe ponerse dentro de una jerarquía lógica que tenga sentido. No solamente hace las cosas más fáciles de encontrar, sino que proporciona un buen "diseño de árbol" que hace que el wiki sea más fácil de leer.

Hay un número de "nodos de nivel principal":

  • Docs - Este es el nodo para la documentación para el usuario final
  • Reglas - Este es el nodo para las reglas de Mandriva
  • Desarrollo - este nodo es para todas las cosas que se relacionan con el desarrollo con la excepción notificada abajo
  • Versiones - Este nodo es para la información de las versiones de Mandriva Linux, el cual incluye notas de la versión, errata, e información de desarrollo particular a esa versión.
  • Herramientas - este nodo es para las distintas herramientas desarrolladas por Mandriva
  • Acerca de - este nodo es para la información miscelánea acerca de Mandriva como un todo
  • Comunidad - información relacionada a la comunidad para cosas tales como fiestas, eventos, enlaces a otros sitios de la comunidad, etc.
  • Proyectos - este nodo es para los proyectos de Mandriva que pueden comprender muchas herramientas, versiones, etc. (tales como "configuración wireless más fácil" sería un proyecto mientras que "drakroam" sería una herramienta)
  • Web - este nodo es para los proyectos y productos relacionados con la web de Mandriva

Estos nodos de nivel principal luego se separan en varios subnodos. Por ejemplo, el nodo lógico de primer nivel Versiones tiene las distintas versiones de Mandriva debajo de él. Entonces el primer subnodo es el mismo del producto, sea Mandriva, Mandrake, o Corporate. Debajo estaría el número de versión, 2007, 3.0, etc. Este nodo sería la "página principal" para esta versión; por ejemplo: Versiones/Mandriva/2007.

Mientras que un sub-nodo contiene información breve perteneciendo a una versión, hay muchísima información por versión para contenerla en una sóla página. Para tal fin, hay más sub-nodos debajo de la versión, tales como "Errata" y "Notas" y "Desarrollo":

Aún podemos ir más allá con sub-nodo "Desarrollo", en otros nodos tales como "Changelog" para un registro de los cambios para esta versión y "nombre en código" o beta/nombre RC/número para la información de una versión en particular. Por ejemplo

Debería ser evidente que hay una progresión lógica de los nodos u hojas que corresponde a su nodo padre. De esta manera, cualquiera que busque informacìón de Mandriva 2007 sabrá que puede encontrarse en el nodo Versiones/Mandriva y que puede seguir navegando desde allí.

Si no está seguro de como deberían crearse los nodos, mire el contenido ya existente o pregunte antes de crear un nuevo nodo.

[editar] Estilo y plantillas

El estilo y el modo en que se escriben los documentos son extremadamente importantes. Algunas personas usan sintaxis de wiki, otras prefieren usar la sintaxis HTML. Algunas personas crean nombres de páginas tales como "Administración del Sistema" mientras que otros usarían CamelCase o nombres abreviados tales como "AdminSis" o "SistemaAdministración".

Algunas personas harán uso de marcas de párrafo cuando no se requiera, otros usarán marcas de salto de línea cuando no hay necesidad, etc. Algunas personas prefieren negritas e itálicas. Estas son todas las cosas que se necesitan "normalizarse" de manera que el diseño y el aspecto del contenido sea consistente página a página.

[editar] Plantillas

MediaWiki permite el uso de plantillas, que proporcionan un estilo consistente para el texto que tratamos de marcar o destacar. Las plantillas se escriben usando:

{{plantilla|texto}}

De manera que para usar la plantilla título para poner énfasis a la descripción o nombre de la página, usamos:

{{título|Este es el título de la página}}

Las siguientes plantilas están disponibles y se deben usar:

  • Plantilla:Título - la plantilla título se usa como el primer elemento de la página para describir los contenidos de la página
  • Plantilla:versión - una plantila para resaltar un número de versión; este debería usarse solamente para números de versiones de las ediciones de Mandriva (i.e. Mandriva Linux 2007)
  • Plantilla:archivo - una plantilla para resaltar nombres de archivos y nombres de directorios (i.e. /etc/ssh/sshd_config)
  • Plantilla:cmd - una plantilla para resaltar un comando rápido que no necesite ser encerrado con las marcas <pre> tales como urpmi --auto-select; comúnmente usados en un párrafo y no por separado
  • Plantilla:media - una plantilla para resaltar un nombre de medio urpmi que no necesita ser encerrado con marcas <pre> tales como /main/release;; comúnmente usado en un párrafo y no por separado
  • Plantilla:prog - una plantilla para resaltar el nombre de un programa que es mencionado (no el nombre de un programa que está siendo usado, sino que está siendo referenciado); esto solamente podría aparecer una vez en un párrafo (la primera vez que se menciona) (i.e. sshd)
  • Plantilla:pkg - una plantilla para reslatar el nombre de un paquete rpm (i.e. openssh-server)
  • Plantilla:menú - una plantilla para resaltar una serie de clics de menú (i.e. Archivo->Guardar)
  • Plantilla:var - una plantilla para resaltar nombres de variables, como bash o perl, etc. (i.e. $HOME)
  • Plantilla:macro - una plantilla para resaltar macros de rpm y otras construcciones "%*" en archivos spec (i.e. %install o %mknombredelib)
  • Plantilla:olang - una plantilla para crear un enlace a temas similares en otros idiomas (ver [[Home] y Fr/Maison para un ejemplo de como usar esto)
  • Plantilla:bug - una plantilla para crear un enlace rápido a bugzilla con un pequeño ícono de un bicho en frente de éste (i.e. {{bug|12345}} se vería como Imagen:bug_small.png informe de fallo #12345)

Estas plantillas existen para usarse y debería hacerse consistentemente y de la manera mencionada arriba. Se usan para proporcionar líneas visuales a medida que se discuten temas y para permitir cosas tales como resaltar nombres de archivos y de paquetes, haciéndolos más fáciles de distinguir.

Note: Nota: Si una plantilla tiene que contener el signo igual (=) o el símbolo de tubería (|) no funcionará a menos que "=" o "|" sean delimitadas con las marcas <nowiki> y </nowiki>

[editar] Estilo

Aquí hay algunos items que deberían prestarse atención en relación al estilo de una página editada:

  • No hay necesidad de usar marcas de párrafo <p>; solamente inserte una línea entre párrafos y el wiki se autoformateará; del mismo modo intente evitar tambien marcas <br>
Obtenido de "http://wiki.mandriva.com/es/Reglas/Wiki_Style"
Herramientas personales