如何设置格式文章

来自Chinese Ikoula Wiki
Jump to navigation Jump to search

zh:如何设置格式文章 he:כיצד לעצב מאמר ro:Cum sa format articolul pl:Jak sformatować art de:Artikel formatieren nl:Hoe te formatteren van artikel it:Come formattare articolo pt:Como formatar o artigo es:Cómo formato artículo en:How to format article ru:Как формат статьи ja:記事の書式を設定する方法 ar:كيفية تنسيق المادة fr:Comment formater son article

这篇文章是从由软件进行自动翻译。你可以看到这篇文章的源代码





这篇文章描述如何格式化您的教程。按照本指南和一个上 写作风格您的教程将适用的建议 ikoula.


Wiki 语法

教程 ikoula 必须使用格式化 wiki 语法. 这篇文章会给你的这种语法最常见的例子。你可以找到更多的细节在 mediawiki 帮助部分 至于 wiki 格式。


章节

要切成章你的教程，你可以使用标题的级别。只要你把标题在页面中，所有的下列项目将视为部分的新篇章，直到下一个同一级别的标题。
这可以是实现的文章的非常有用的你可读性提高切割出不同阶段。

不同级别的标题

标题的级别 1 对应于文章的标题。当你创建你的页面时，它是自动创建。曲目都围绕你的标题的迹象 "=".标题的级别 2 对应于第一章或每节的标题。
本节标题示例 :

==Chapitres==

更会登录到您的标题，你的事情越多倒这棵树。

示例 结果 
===Titre de niveau 3===
====Titre de niveau 4====
=====Titre de niveau 5=====

Titre de niveau 3

Titre de niveau 4

Titre de niveau 5


值得一提的尽快至少有，在文章的头会自动显示目录 4 章节或 subchapters。

风格

您可以使用 wiki 语法和几个 HTML 标记设置文本的格式。

大胆

这里是如何结束粗体形式出现在你的文章。

示例 结果 
'''加粗文本 '''

texte en gras


这里是应以粗体显示的项的列表。

  • 一个 GUI 的可见文本
  • 对于控件，例如，更改用户或服务器的语境的变迁
  • 作为主机名 服务器-1
  • 用户喜欢 ikoula
  • 快速
  • 列出的条款，作为 :
    • MySQL: 数据库引擎
    • Apache: web 服务器
  • 玩家不应错过的元素使它没有太多。


斜体

只应使用斜体引进技术术语。例如 : 服务器将用作 nginx 反向代理 .

示例 结果 
''斜体文本 ''

texte en 斜体


注意和警告

一些 HTML 标记的使用可能需要突出显示某些元素如笔记或警告。

示例 结果 
<div style="background-color: #FFCC99;"> '''注意 ''': 这是一份说明。</div>



<div style="background-color: #FF9999;"> '''警告 ''': 这是一个警告。</div>
Note: Ceci est une note.


Warning: Ceci est un avertissement.



文章内容

文章内容  是块在哪里你的文本的格式不同。要做到这一点，只是将空间放在开头的句子，或者你从标记的文本括起来  <pre>. Votre texte sera alors formaté dans un cadre avec une police différente.


示例 结果

重要的文本 ''italique''
ou
<pre>Texte important ''italique''</pre> 

Texte important italique

ou 

Texte important ''italique''

正如你所指出的标记的用法， <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'使用标记 GeSHi ou la méthode des notes et avertissements pour afficher du code source ou 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.

示例 结果

<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 ou 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 ou des commandes, si ces derniers ne le sont pas.
示例 :

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
示例 结果 
* é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 ou un fichier
Exemple Résultat 
;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

Les 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.

Exemple Résultat 
# élément 1
# élément 2
  1. élément 1
  2. é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. Les 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. Les 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! Les 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


Exemple Résultat 
{|
|橙色 
|苹果 
|-
|面包 
|馅饼 
|-
|黄油 
|冰激淋  
|}
Orange Apple
Bread Pie
Butter Ice cream

上表的详细信息，请咨询 手动维基

脚本和文件

一定要描述的文件或脚本你提到的作用。以这种方式的读者会有相同级别的信息，你更能够理解你的做法。

脚本

当你给一个脚本或配置文件的内容时，请确保它评论，最好是一级线有关。其目的是读者理解的所有操作描述，所以它都是重要的是尽可能多的教育。这种方式，它将能够更多自定义、 更新或长期诊断其服务器的问题。

如果您发布的文件有很长的部件和 /或不感兴趣为您的教程，你可以省略这些缔约方与椭圆 (...).
我们建议使用 Balise 隔世 若要显示脚本或文件的内容。后者将允许你，除了语法高亮显示，只是表示数量的线和突出更重要。它建议你使用突出显示以指示线那里有变化来执行。

Exemple Résultat 
<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>


文件

你有可能在您的教程中插入文件或图像。最简单的方法来实现的事是不用在你的文章，然后一次放到网上文档完成写作。如果该文件不存在，它将一个红色的链接指向。通过点击这个链接，你会来到一个页面，将允许您上传您的文件。

Exemple Résultat 
[[Media:mon_fichier.txt]]

Media:mon_fichier.txt

指向文件的链接只取决于文件的名称，它是值得的。建议你使用描述性内容尽可能的文件的名称。别忘了包括文件的说明，当你把它放到网上。

图像

图像被视为文件。因此，您可以包括他们和放文件相同的方式在网上。
与文件唯一的区别是，将文本中显示的图像。谁给你更多的选项来显示。

要遵守的语法是 : 

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

选项和描述是可选的。

Exemple Résultat 
[[File:sample_image.jpg|200px|thumb|right|modèle image]]
  • 200px : 调整大小以显示
  • thumb : 图像墨水中会显示说明设置
  • right : 正确的图像的对齐方式
文件:Sample image.jpg
modèle image


你可以找到有关可用的不同选项的详细信息，在图像处理上 mediawiki 手册.
避免使用太沉重的图像和更愿意使用 jpg、 jpeg 和 png 格式。

键盘键

若要描述键盘键，请按照这些建议 :

  • 把它们写在大写
  • utiliser la balise <span>
  • utiliser le symbole + si elles doivent être pressées simultanément
Exemple Résultat 
支持  <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">供应 </span> 然后  '''任务管理器 '''

Appuyer sur CTRL+ALT+SUPP puis Gestionnaire des tâches


主机名称

建议你使用主机名可能的最具体的相关的服务器角色。
Exemple :

  • dns_serveur
  • bdd_master
  • proxy_nginx
  • 等�


域名

当你正在处理域名时，更愿意使用字段 domain.tld 作为默认域。 如果您有多个域名，不用说，你可以选择要使用的名称，如 域-1.tld, 域-2.tld等。

为子域，我们推荐您使用此子域将附加到的的角色的名称作为 master.Domaine.tld , slave.Domaine.tld , BDD.Domaine.tld 等。

IP 地址

若要避免在您的教程中披露您的 IP，尽可能地清晰，我们邀请您来满足 保留的地址 文档。在本例中，我们更愿意使用块地址 203.0.113.0/24 这是公共地址的一切。要么 203.0.113.0 à 203.0.113.255.

对于本地网络和本地主机的地址，您可以保留您通常使用的 IP。它意味着 :

  • 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



链接

Créer un lien

截图

如果您的教程描述的实际行动，实现在图形界面上，它是最好包括屏幕截图，使它更为清晰。 小心，但是不太会。这不是问题有截图为每个按钮、 文本或链接框，而只是它需要成功的驱动器来追随你。
如果你想要捕获突出显示的项目，请随时向点添加箭头或帧。这只会是唯一的综合教程。

我们建议你将你提到的元素放在脂肪和是以图形化的界面，它是一个按钮、 链接、 一个复选框，等等。
别忘了添加描述，当你在线打开图像。

结论

请包括到您的教程，将总结做过并介绍随后可能做简短的结论。
你拥有了一切你需要创建你自己的文章 ! 此外，您还可以参考我们的文章上 风格 iKoula和良好的写作 !


这篇文章似乎你要有用 ?

0



您未被允许发表评论。

取自“https://zh-wiki.ikoula.com/index.php?title=如何设置格式文章&oldid=7739”