Bienvenido a la wiki dedicada a los usuarios nuevos en GNU/Linux, este sitio esta orientado a ayudar a los usuarios nuevos... Si deseas contribuir, por favor crate una cuenta.

Ayuda:Normas

De PUFs Wiki

Antes de crear nuevos artículos o editar artículos existentes por favor lee las normas de la wiki, de esta forma podemos mantener un estilo consistente a lo largo de la misma.

Tabla de contenidos


[editar] Normas de edicón de la Wiki

Todos los artículos deben, en caso de ser posible cumplir con las siguientes condiciones:

  • Deben comenzar las palabras que no sean conectores con mayúsculas. Ej: Este es un Hardware Viejo.
  • Deben tener una tabla de contenidos precedida de un breve resumen o introducción al artículo. Para forzar el uso de la tabla de contenidos utilicen la palabra mágica __TOC__ que le dice a la wiki dónde ubicar la misma.
  • Los artículos deben empezar con la introducción/resumen antes mencionado y jamás con un encabezado H1, ya que este encabezado lo pone automáticamente la wiki.
  • Entre el título de una sección y su contenido no se dejarán líneas en blanco.
  • Entre el fin de una sección y el título de la sección siguiente debe haber dos líenas en blanco.
  • Las secciones deben comenzar con un ecabezado H1, para las subsecciones utilizar los encabezados subsiguientes.
  • Los artículos relacionados con Software deben utilizar la plantilla Plantilla:Software_info. Utilizar 250px para las capturas de pantalla, los logos no deben exceder el ancho de la captura de pantalla.
  • Los artículos de Hardware deben utilizar la plantilla Plantilla:Hardware_info.
  • Los artículos deben corresponder a una categoría. Ver Categorías.
  • Los comandos que se quieran resaltar deben estar en negritas.
  • Los archivos que se quieran resaltar deben estar en cursivas.
  • El contenido entre paréntesis no debe estar separado de los mismos, ej: (no está separado de los paréntesis).
  • El código fuente debe estar delimitado por las directivas <code lenguaje></code>. Ver Normas de Código Fuente.


[editar] Normas de Código Fuente

Normas para código C/C++ ( <code c></code> ):

  • Los archivos de cabecera irán al principio del código, jamás en otro lado
  • Las definiciones deben ir luego de los archivos de cabecera separados por al menos una línea en blanco.
  • Las declaraciones de variables se harán al principio de la función, en el caso de variables globales debe hacerse luego de la inclusión de archivos y las definiciones, dejando una línea en blanco al menos para separar de la sección anterior.
  • Los comentarios se harán exclusivamente entre /* y */ para código C, ¡¡¡ no usar extensiones !!!
  • Se dejará un espacio en blanco entre el identificador de la función/variable y el paréntesis, además las comas deben ir pegadas a su primer argumento y separadas por un espacio de su segundo argumento. Ej: 
void funcion ( int parametro1, void *parametro2 );
  • Las llaves deben empezar en una línea sola al mismo nivel de identación anterior.
  • El código se identará con 3 espacios.
  • ¡¡ main debe devolver siempre int !! Puede tomar tanto 0 como 3 parámetros. ¡¡ El return siempre debe estar !!
  • Se permite código ISO C99.

Ejemplo: 

#include <stdio.h>
 
/* Definiciones */
#define PI 3.141592653f
#define E  2.718281828f
 
/* Variables globales */
const float fPi = PI;
const float fE = E;
 
/* Main tomando tres argumentos */
int main ( int argc, char *argv[], char *envp[] )
{
   printf ( "pi: %f\n", fPi );
   printf ( "e: %f\n", fE );
 
   return 0;
}

Código BASH ( <code bash></code> ):

  • Siempre se debe incluir #!/bin/sh, jamás #!/bin/bash ya que puede haber sistemas donde bash no esté.
  • En lo posible no utilizar extensiones BASH.
  • Los comentarios siempre deben empezar en una línea sola.
  • La identación se realizará con 3 espacios

Código Python ( <code python></code> ):

  • Seguir las mismas reglas que los otros

Código Perl ( <code perl></code> ):

  • Seguir las mismas reglas que los otros


[editar] Categorías

Obtenido de "http://www.buntulug.com.ar/wiki/Ayuda:Normas"
Herramientas personales