Directivas del Codex
¡Bienvenido!: Esta página busca establecer las prácticas recomendadas para los editores y voluntarios del Codex. Si tiene una sugerencia para mejorarla, por favor publique una nota en la Lista de Correo de Documentación de WordPress.
Meta Reglas
- Escriba WordPress usando las letras apropiadas. WordPress
- Publique con precisión, prontitud y frecuencia.
- Edite sin misericordia.
- Si tiene alguna duda, PREGUNTE.
- Diviértase. :)
Practicas Estándar
Nuevas Páginas
Las nuevas páginas y artículos son bienvenidos. Aunque existe un proceso.
Si no es un usuario registrado, siga estas instrucciones: Contribuir: Primero lo primero.
Si el artículo está totalmente completo, puede añadirlo como una nueva página. Vea: Creando una Página Nueva.
Si el artículo está incompleto y/o es un borrador, puede añadirlo como una subpágina de su página de usuario. Vea Creando una Página de Usuario.
Por favor, siga las Reglas de Estilo del Codex para los artículos establecidas en: Estilos del Codex.
Las siguientes son directrices para agregar contenido nuevo al Codex:
- Si hay un artículo que se parezca al suyo, mejore el ya existente.
- Use la página Sandbox para practicar los estilos.
- Añada enlaces de otros artículos a su artículo para desarrollar interconexiones entre los artículos. No cree "páginas cerradas". Estas son páginas sin enlaces a otras páginas del Codex.
- Una vez que las páginas son creadas, están en línea y cualquier enlace a hacia ellas funcionará. Cuando un usuario hace click hacia una página vacía le está haciendo perdiendo su tiempo. Cree sólamente páginas cuando tenga el contenido completo y preciso para colocar en ellas.
- Una vez completada su página y movida a la documentación desde su página de usuario, los enlaces deben realizarse desde la "sub" Tabla de Contenidos y otros documentos relacionados al nuevo artículo. Pregunte si no está seguro donde crear un enlace en esta sub-Tabla de Contenido. No coloque enlaces en la Portada sin permiso del Equipo de Documentación.
Use los siguientes "marcadores" o categorías que designan el estado en que se encuentra un artículo:
- {{Stub}}
- Stub categoriza la página como incompleta y que necesita edición y expansión.
- {{Draft}}
- Coloque esto al inicio de la página. Todas las páginas añadidas son exploradas por los buscadores. El marcador Draft en el inicio de la página le advertirá a los lectores de que se trata de un trabajo en progreso, que la información puede ser incorrecta y también puede evitar que otros la editen hasta que haya terminado de trabajar en ella.
- [[Category:New page created]]
- Define una página como nueva y por lo tanto atraerá la atención de los editores. No la utilice hasta que no esté listo para editar y/o mover el artículo a la documentación general desde su página de usuario.
- {{Copyedit}}
- Copyedit designa al artículo como que todavía necesita trabajo, normalmente una revisión y edición general. Lo marca como totalmente completo, pero necesita revisión. Use {{Stub]] para artículos incompletos.
Títulos
Los Títulos para las páginas nuevas deben estar en Formato de Título.
Todos los Encabezados o Titulares también deben estar en formato de título. Por ejemplo, use "Usando el Administrador de Enlaces" no "Usando el administrador de enlaces". Deben ser títulos completos. No "IntroducciónalosBlogs" sino "Introducción a los Blogs".
También deben seguir las reglas del Dr. Gramática con respecto al uso de mayúsculas:"En los títulos deben colocarse mayúsculas en la primera palabra, la última palabra y en las palabras entre ellas, excepto en los artículos (un/una(s)/uno(s) y el/la/los), en la preposiciones de menos de cinco letras (en, de, para), y en las conjunciones de coordinación (y, pero). Estas reglas se aplican a los títulos de trabajos largos, cortos o parciales así como sus propios artículos" (Anson, Schwegler, y Muth. The Longman Writer's Companion 240)
- Los títulos deben orientarse a acciones o tareas siempre que sea posible. Por lo que es preferible escribir "Usando el Administrador de Enlaces" a "El Administrador de Enlaces" por ejemplo. ¿Que términos de búsqueda utilizará el usuario cuando busque la información?
- Los títulos no deben tener espacios innecesarios entre letras o entre líneas. Trate de evitar el uso de símbolos como "-", "#", "?" y "+".
- Los títulos cortos son mejores.
- Por favor, evite tanto como sea posible usar preposiciones en los títulos.
- En caso de duda con respecto a lo adecuado de un nombre, envíe un correo electrónico a la lista de correo de documentaciín solicitando sugerencias.
- No use CamelCase para los títulos de las páginas: El Codex no utiliza CamelCase como lo hacen otros wikis. Todos los títulos de las páginas y por lo tanto los enlaces deben estar en formato de título normal. Por ejemplo, la página acerca del Codex debe tener el título "Acerca del Codex", y el enlace formateado así:
[[Acerca del Codex]] y no el formato CamelCase [[AcercaDelCodex]].
SubPáginas
No cree subpáginas de una página diferente a la de sus propia página de Usuario sin discutirlo primero en la lista de correo wp-docs .
Discusiones
Usando las páginas "Conversar"
¿Vió algo que quizá es erróneo o necesita aclaración? La mejor manera de hacer mención a estos problemas es utilizar la función DISCUSIÓN. Por favor, absténgase de añadir sus comentarios directamente en la página del ARTÍCULO. En la parte superior de cada página hay una pestaña DISCUSSION . Este es el lugar para dejar sus comentarios, sugerencias y cosas por el estilo. ¡Gracias!
- Dejar Mensajes acerca del Artículo: Para dejar un comentario con respecto a un artículo, haga click en la pestaña Discussion del artículo y publíquelo y fírmelo.
- Dejando mensajes para los Usuarios: Deje un mensaje a un usuario editando la página User:Talk asociada con este usuario. Fírmelo. El usuario recibirá una solicitud visual la próxima vez que visite el Codex e ingrese al sitio.
- Separar Comentarios: Por favor, cree una línea horizontal entre los comentarios en la página de discusión usando los cuatro guiones ---- entre los comentarios. Si está iniciando un nuevo tema de conversación, considere usar el enlace "+" junto a editar, el cual permite crear una nueva sección.
- Firme siempre sus Comentarios: para añadir su "firma" a un comentario, añada cuatro acentos ~s (acentos) al final de sus comentario. Esto mostrará su nombre de usuario y un enlace a su Página de Usuario y añade una Marca de tiempo. Esto es muy útil para las páginas de discusión . Un método alternativo consiste en hacer click en el ícono de firma en la parte superior de la ventana editar ...es la segunda desde la derecha.
Voz, Estilo y Audiencia del Codex
La "voz" del Codex de WordPress es la de una autoridad, pero con tono de voz conversacional amigable. El estilo del Codex es para educar brindando explicaciones sencillas y fáciles-de-utilizar siempre que sea posible y de consejo técnico cuando sea necesario.
En general, los artículos son escritos al lector, llevando al lector a través del proceso. El pronombre "Yo" raramente es utilizado, enfocándose en "Ud. hace click aquí" y "abre un archivo de plantilla". No se trata de lo que Ud., el autor hizo, la historia detrás de sus decisiones, o de todas las personas que le ayudaron a lograrlo. Se trata de lo que necesita hacer el usuario a fin de crear y tener funcionando su sitio WordPress rápidamente.
Las viñetas y listas se utilizan para indicar los pasos necesarios para estructurar y facilitar el proceso. Las tareas complicadas son divididas en pequeños pasos, guiando al usuario principiante o avanzado rápidamente hacia la solución.
La audiencia es extremadamente variada en conocimientos y destrezas en HMTL, XHTML, CSS, y PHP. Los artículos ubicados dentro de Temas Avanzados y Documentación para Desarrolladores están dirigidos al usuario experimentado. Las Lecciones de WordPress están diseñadas para el principiante, usando un lenguaje como que si el autor fuera la persona de soporte técnico y se encontrara sentado justo al lado del usuario de la computadora, guiándole a través del proceso. El resto del Codex está dirigido a usuarios de los niveles principante a intermedio y debe contener un lenguaje sencillo con enlaces a las definiciones ubicadas en el Glosario cuando sea necesario.
Convenciones
- Nombres de Sitios Web de Ejemplo: Utilice siempre ejemplo.com, ejemplo.org o ejemplo.net cuando necesite señalar un nombre de dominio como ejemplo. Esto es debido a RFC2606
- Admin: El usuario administrador principal siempre tiene el nombre de usuario o login
admin
- Usar Nombres de Personas en los Ejemplos: Cuando sea necesario usar un nombre para un usuario común, no-administrador, o una persona, use "Harriet" como nombre y "Smith" como apellido.
- WordPress se escribe WordPress: WordPress se escribe con DOS letras mayúsculas: WordPress.
Temas Relacionados