Cómo formato artículo

pt:Como formatar o artigo en:How to format article fr:Comment formater son article

Este artículo ha sido traducido por un software de traducción automática. Usted puede ver el origen artículo aquí.

Este artículo describe cómo formatear tu tutorial. Siguiendo esta guía y uno en el estilo de escritura, el tutorial aplicará las recomendaciones de Ikoula.

Sintaxis wiki

Tutoriales Ikoula debe ser formateado utilizando la sintaxis wiki. Este artículo da los ejemplos más comunes de esta sintaxis. Puede encontrar más información en el sección de ayuda de MediaWiki en cuanto al formato wiki.

Capítulos

Para cortar tus tutoriales en capítulos, puede usar los niveles de título. Tan pronto como pones un título en la página, todos los siguientes artículos serán considerados como parte del nuevo capítulo, hasta el próximo título del mismo nivel.
Esto puede ser muy útil para mejorar la legibilidad de su artículo cortando a las diferentes etapas de realización.

Los distintos niveles de título

El título del nivel 1 corresponde al título del artículo. Se crea automáticamente al crear tu página. Las pistas se construyen alrededor de su título por signos "=". El título del nivel 2 se corresponde con el primer título de capítulo o sección.
Ejemplo para el título de esta sección :

==Capítulos ==

Más te matriculas alrededor de su título, más bajar el árbol.

Ejemplo	Resultado
===Nivel título 3=== ====Nivel título 4==== =====Nivel título 5=====	Nivel título 3 Nivel título 4 Nivel título 5

Cabe destacar que una tabla de contenido aparece automáticamente en la cabeza de artículo tan pronto como hay por lo menos 4 capítulos o subcapítulos.

Estilos

Puede dar formato al texto utilizando la sintaxis wiki y algunas etiquetas HTML.

Audaces

Aquí es cómo terminar audaz en tu artículo.

Ejemplo	Resultado
'''texto en negrilla '''	texto en negrilla

Aquí está una lista de artículos que deben ser en negrilla.

• Texto visible de una GUI
• Cambio de contexto para un control, como cambiar de usuario o servidor
• Nombres como Servidor - 1
• Usuarios como Ikoula
• Rápido
• Lista de términos, como :
  • MySQL : motor de base de datos
  • Apache : servidor Web
• Elementos que el jugador no debe perderse, lo hacen sin demasiado.

Italic

Cursiva debe utilizarse para introducir términos técnicos. Por ejemplo : el nginx se utilizará como servidor Reverse proxy .

Ejemplo	Resultado
''texto en cursiva ''	texto en cursiva

Notas y advertencias

El uso de algunas etiquetas HTML puede ser necesario para destacar ciertos elementos como notas o advertencias.

Ejemplo	Resultado
<div style="background-color: #FFCC99;"> '''Note''': Ceci est une note.</div> <div style="background-color: #FF9999;"> '''Warning''': Ceci est un avertissement.</div>	Note: Ceci est une note. Warning: Ceci est un avertissement.

Blockquotes

El blockquotes son bloques donde el texto con un formato diferente. Para hacer esto, simplemente coloque un espacio al principio de frase o adjuntar el texto de etiquetas <pre>. Votre texte sera alors formaté dans un cadre avec une police différente.

Ejemplo	Resultado
Importante texto ''cursiva '' o <pre>Texte important ''cursiva ''</pre>	Importante texto cursiva o Texte important ''cursiva ''

Como se ha señalado, el uso de la etiqueta <pre> fait que tout autre formatage à l'intérieur du bloc sera ignoré et considéré comme du texte à afficher. Si vous utilisez la première méthode, avec l'espace en début de ligne, sachez qu'un retour à la ligne fermera le cadre.
Nous préconisons d'Utilice la etiqueta GeSHi o la méthode des notes et avertissements pour afficher du code source o des informations importantes.

Code source

Lorsque vous publiez un code source, vous devez appliquer la balise <syntaxhighlight>. Cela permettra à votre code de bénéficier d'une coloration syntaxique, le rendant plus lisible. Afin d'adapter la coloration au langage utilisé, ajoutez l'option lang="langage" dans la balise.

Ejemplo	Resultado
<syntaxhighlight lang="php"> <?      $hello = "Hello World";      echo $hello; // comment ?> </syntaxhighlight>	<? $hello = "Hello World"; echo $hello; // comment ?>

Vous trouverez sur le site de l'extension GeSHi la liste des langages supportés et quelques options supplémentaires, telle l'ajout de numéros de ligne o la mise en évidence d'une ligne dans le code.

Référence à une application

Lorsque vous mentionnez une application, préférez utiliser la capitalisation du site officiel. Si le site web n'est pas consistent, choisissez une forme et essayez de l'être dans votre article.
Par contre, ne capitalisez pas les noms de paquets o des commandes, si ces derniers ne le sont pas.
Ejemplo :

A MySQL  database vs. the mysql command or the mysql-server package.

Listes

A chaque type de liste son utilisation.

Listes non-ordonnées

Ces listes sont utiles pour :

• les prérequis
• les checklists

Ejemplo	Resultado
* élément 1 * élément 2	élément 1 élément 2

Listes de définitions

Ces listes sont utiles pour :

• les termes et explications
• explications pour les variables dans une ligne de commande o un fichier

Ejemplo	Resultado
;mot 1 : définition 1 ;mot 2 : définition 2-1 : définition 2-2	mot 1 définition 1 mot 2 définition 2-1 définition 2-2

Listes ordonnées

El listes ordonnées sont à utiliser avec parcimonie. Elles peuvent s'avérer pratiques pour lister l'ordre d'un processus, tel que le traitement d'une requête DNS.

Ejemplo	Resultado
# élément 1 # élément 2	élément 1 élément 2

Ces listes sont utiles pour :

• décrire un processus de traitement

Dans certains cas, l’utilisation d'un tableau sera préférable aux listes.

Tableaux

Voici un exemple simple de tableau. Cela peut être utile pour présenter plus facilement un code exemple et son résultat. El tableaux sont structurés comme suit.

{|	début de tableau
|+	descriptif du contenu, optionnel; un seul par tableau positionné entre le début du tableau et la première ligne
|-	début de ligne, optionnel sur la première ligne -- le moteur de wiki prend en charge la première ligne
!	cellule entête, optionnel. El entêtes peuvent être mises soit sur la même ligne séparées par des doubles points d'exclamations (!!), soit sur des lignes séparées, chacune ayant son unique point d'exclamation (!).
|	cellule de donnée , requis! El cellules de données consécutives d'un tableau peuvent être soit mises sur la même ligne séparées par une double barre verticale (||), soit sur des lignes séparées, chacune ayant son unique barre verticale (|).
|}	fin de tableau

Ejemplo	Resultado
{| |Naranja |Apple |- |Pan |Tarta |- |Mantequilla |Ice cream |}	Naranja Apple Pan Tarta Mantequilla Ice cream

Para obtener más información sobre tablas, consulte el Manual wikimedia

Secuencias de comandos y archivos

N'oubliez pas de décrire le rôle des fichiers o scripts que vous mentionnez. De cette manière le lecteur aura le même niveau d'information que vous et sera plus à même de comprendre votre démarche.

Secuencias de comandos

Lorsque vous donnez le contenu d'un script o d'un fichier de configuration, assurez vous qu'il soit commenté, de préférence au niveau des lignes concernées. Le but est que le lecteur comprenne l'ensemble des actions décrites, il est donc important d'être le plus didactique possible. De cette manière, il sera plus à même de personnaliser, mettre à jour o diagnostiquer les problèmes de son serveur sur le long terme.

Si los archivos que publiques tienen piezas largas y /o non intéressantes pour votre tutoriel, vous pouvez omettre ces parties avec l’ellipse (...).
Se recomienda el uso de la Balise GeSHi pour afficher le contenu des scripts o fichiers. Cette dernière vous permettra, en plus de la coloration syntaxique, d'indiquer simplement des numéros de lignes et de surligner la o les plus importantes. Nous vous recommandons d'utiliser le surlignage pour indiquer les lignes où il y a des modifications à effectuer.

Ejemplo	Resultado
<syntaxhighlight lang="apache" line start="10" highlight="5"> <VirtualHost *:80> DocumentRoot /www/example1 ServerName www.example.com # Other directives here </VirtualHost> </syntaxhighlight>	10<VirtualHost *:80> 11 DocumentRoot /www/example1 12 ServerName www.example.com 13 # Other directives here 14</VirtualHost>

Archivo

Vous avez la possibilité d'insérer un fichier o une image dans votre tutoriel. Le plus simple pour réaliser la chose est de mentionner le document dans votre article, Entonces de le mettre en ligne une fois la rédaction terminée. Si le fichier n'existe pas déjà, il sera pointé par un lien rouge. En cliquant sur ce lien, vous arriverez sur une page que vous permettra de téléverser votre fichier.

Ejemplo	Resultado
[[Media:mon_fichier.txt]]

Cabe destacar que el enlace al archivo depende exclusivamente el nombre del archivo. Se recomienda que utilice nombres tan descriptivos como los posibles archivos. No se olvide de incluir una descripción del archivo cuando se pone en línea.

Imágenes

El images sont considérées comme des fichiers. Vous pouvez donc les inclure et les mettre en ligne de la même manière que les fichiers.
La única diferencia con un archivo es que la imagen se mostrará en el texto. Qué te da más opciones para mostrar.

La sintaxis para cumplir es :

[[File:sample_image.jpg|options|description]]

El options et la description sont facultatives.

Ejemplo	Resultado
[[File:sample_image.jpg|200px|thumb|right|modèle image]] 200PX  : tamaño para mostrar thumb : la imagen está escrita en un escenario que mostrará la descripción right : alineación de la imagen derecha	modèle image

Puede encontrar más información sobre las diferentes opciones disponibles en la manipulación de la imagen en el manual de MediaWiki.
Evite utilizar imágenes muy pesadas y prefieren usar los formatos jpg, jpeg y png.

Teclas teclado

Para describir las teclas del teclado, siga estas recomendaciones :

• escribir en mayúsculas
• Utilice la etiqueta <span>
• utiliser le symbole + si elles doivent être pressées simultanément

Ejemplo	Resultado
Apoyo en <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> Entonces '''El administrador de tareas '''	Apoyo en CTRL+ALT+SUPP Entonces El administrador de tareas

Nombres de host

Se recomienda que utilice la más específica posible, que es en relación con la función del servidor de nombres de host.
Ejemplo :

• dns_serveur
• bdd_master
• proxy_nginx
• etc.

Nombres de dominio

Cuando se trata de nombres de dominio, prefieren utilizar el campo domain.TLD como el dominio predeterminado. Si tienes varios nombres de dominio mencionar, puede utilizar nombres como dominio - 1.TLD , dominio - 2.TLD etc. |

Para subdominios, le recomendamos que utilice un nombre en relación con el papel a que se sujetará este subdominio, como master.domain.TLD , slave.domain.TLD , bdd.domain.TLD etc. |

Direcciones IP

Para evitar revelar tu IP en tus tutoriales y ser lo más claro posible, lo invitamos a conocer la direcciones reservadas a la documentación. En nuestro caso, preferimos utilizar las direcciones de bloque 203.0.113.0/24 por todo lo que es público. Cualquier 203.0.113.0 à 203.0.113.255.

Para las direcciones de las redes locales y localhost, puede guardar la IP que usas. Significa :

• 10.0.0.0/8 - 10.0.0.0 – 10.255.255.255
• 172.16.0.0/12 - 172.16.0.0 – 172.31.255.255
• 192.168.0.0/16 - 192.168.0.0 – 192.168.255.255
• 127.0.0.0/8 - 127.0.0.0 – 127.255.255.255

Enlaces

Créer un lien

Imágenes

Si tu tutorial describe las acciones a realizar en una interfaz gráfica, es mejor incluir capturas de pantalla para que sea más claro. Attention toutefois à ne pas en faire de trop. Il n'est pas question d'avoir une capture pour chaque bouton, zone de texte o lien, mais juste ce qu'il faut pour que le lecteur réussisse à vous suivre.
Si vous souhaitez mettre des éléments de la capture en évidence, n'hésitez pas à y ajouter des flèches o cadres pour les pointer. Cela n'en rendra le tutoriel que plus compréhensif.

Nous vous recommandons de mettre en gras les éléments que vous mentionnez et qui sont dans l'interface graphique, que ce soit un bouton, un lien, une case à cocheretc. |
No se olvide de añadir una descripción al girar la imagen en línea.

Conclusión

Por favor incluya una conclusión breve de tu tutorial que resumir lo que ha hecho y presentar lo que se podría hacer posteriormente.
Tienes todo lo necesario para crear tus propios artículos ! Además, también puede consultar nuestro artículo sobre el estilo iKoulay buena escritura !

Este artículo parecía que ser útil ?

0

Votar

Ordenar por fecha Ordenar por valoración

Habilitar actualización automática de comentarios

No puedes publicar comentarios.